Publish an app to its live site.

Publishes the app to its live site: its managed address, and every custom domain attached to it (changes kind domain) once that domain is active. A domain that becomes active later joins the live site without another publish. Check GET .../publishability first and send the sourceRunId it returns, so the build the creator approved is the one that goes live. Returns a publish job: poll GET .../infra/publish-jobs/{publishJobId} until status is succeeded (publishedUrl is the live site) or failed (error says why). Send the same idempotencyKey to retry safely.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:clientportal-ai.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

The API version.

Available optionsv3

Example:v3

Path Parameters

projectIdstringrequired

The project.

Possible values: Value must match regular expression ^prj_[A-Za-z0-9_-]+$

Example:prj_5f0c2a3e

Body

application/json

sourceRunIdstring

Exact successful run backing the preview approved by the creator. When provided, publish fails closed instead of selecting a different run that became ready concurrently.

Possible values: Value must match regular expression ^run_[A-Za-z0-9_-]+$

Example:run_7b2c9e41

idempotencyKeystring

Stable retry key. Domain-aware clients should always provide one; when omitted, source-bound requests receive a deterministic server-generated key while source-less legacy requests remain independent publish attempts.

Possible values: non-empty and <= 200 characters

Example:publish-prj_5f0c2a3e-2026-10-23

Response

202

application/json

Publish job accepted.

jobIdstringrequired

The publish job; poll it with GET .../infra/publish-jobs/{publishJobId}.

Example:job_3f9a1c2b7d4e5f6a7b8c9d0e

hostnamestring | nullnullablerequired

The managed address the app is published to.

Example:5f0c2a3e.app.clientclub.net

aliasesstring[]required

The active custom domains the publish also serves.

Example:["portal.acmefitness.com"]

domainRevisioninteger | nullnullablerequired

The managed address's revision this publish took.

Possible values: >= 0

Example:1

url(string | null)<uri>nullablerequired

The live site's address once the job succeeds.

Example:https://5f0c2a3e.app.clientclub.net

statusstringrequired

The job's state; queued when accepted.

Available optionsqueuedrunningsucceededfailed

Example:queued