API ReferenceCustom Views Experimental

Publish a custom view (experimental)

⚠️ **Experimental** — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet. Flips the view from DRAFT to PUBLISHED. Only PUBLISHED views are served on the embed data path — this is the gate that stops an unreviewed view reaching end-customers. Idempotent: publishing an already-published view is a no-op success. The response returns a `previewUrl` — give it to the user so they can open the view in Paid.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

displayIdstringRequired

Request

Body

Response

200
displayIdstring

Stable public identifier used in preview/embed URLs.

namestring
statusenum

A view is DRAFT until explicitly published; only PUBLISHED views are served to end-customers.

previewUrlstring or nullformat: "uri"
Absolute URL to open this view in the Paid app for preview. Surface it to the user after creating or publishing a view. Null when the app URL is not configured.
scopeenum

‘customer’: data is scoped to one viewing customer and the view is embeddable per-customer. ‘organization’: data is org-wide and the view is internal-only.

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error