Skip to main content
Version: v3

Publish a saved revision of an app to its members.

POST 
/ai-builder-api/projects/:projectId/app-config/publish

For a phone app send platform: mobile and the revision from GET .../app-config: installed apps get it over the air. Screens your agent wrote reach members only in a new APK (POST .../app-config/apk-builds). web, the default, is for ClientPortal configuration apps; a coded web app publishes with POST .../infra/promote-to-production.

Request​

Version stringrequired

The API version.

Available optionsv3
projectId stringrequired

The app's id.

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

application/json

Bodyrequired

    revisionintegerrequired

    The revision to publish: the app configuration's revision, once appliedRevision matches it and status is ready.

    Possible values: >= 1

    platformstring

    mobile for a phone app. web (the default) publishes a ClientPortal configuration app's web revision.

    Available optionswebmobile
application/json

Published configuration.

Schema
    projectIdstringrequired

    Stable owner project for this location's shared ClientPortal Experience. It may differ from the web or mobile project in the current route.

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

    revisionintegerrequired

    The newest saved revision. A finished run or a restore saves a new one.

    Possible values: >= 0

    appliedRevisionintegerrequired

    The newest revision that finished applying. Publish a revision once it equals revision and status is ready.

    Possible values: >= 0

    publishedRevisionintegerrequired

    The revision members get. 0 until the first publish.

    Possible values: >= 0

    statusAppCustomizationStatusrequired

    Where the newest revision is: ready once it has applied and can be published, failed when it could not apply.

    Available optionsidlequeuedapplyingreadyfailed
    previewUrlstring<uri>

    Where the latest applied revision can be previewed, when the app has a preview.

    lastErrorstring

    Why the latest revision failed to apply, when status is failed.

    createdAtstring<date-time>required

    When the app's configuration was first saved.

    updatedAtstring<date-time>required

    When the latest revision was saved or changed state.