Skip to content

Create App

POST
/apps

PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.

Create an app. It starts in draft and serves no traffic until published.

The slug is unique within your organization, not globally — two builders may both ship a crm. A collision returns 409 naming slug.

Authorizations

Parameters

Header Parameters

X-Org-Id
Any of:
string

Request Body required

Mirrors CreateAppInput.

object
name
required
string
>= 1 characters <= 200 characters
registered_origins

Https-only origins a browser app token may be presented from. An http origin is rejected — a bearer token sent over http is a token disclosed to the network.

Array<string>
<= 20 items
slug
required

Stable identifier, unique within your organization. Lowercased on write, so CRM and crm are the same app.

string
>= 1 characters <= 100 characters /^[a-zA-Z0-9][a-zA-Z0-9_-]*$/

Responses

201

Successful Response

object
data
required

One builder-owned app. Mirrors AppDto.

object
app_id
required
string
archived_at
Any of:
string format: date-time
builder_org_id
required
string
created_at
Any of:
string format: date-time
default_hostname
Any of:
string
name
required
string
registered_origins

Https-only origins a browser app token may be presented from.

Array<string>
slug
required
string
source_credential_ref
Any of:
string
source_default_branch
Any of:
string
source_provider
Any of:
string
source_repo_url
Any of:
string
status
required

Lifecycle state: draft, published, suspended or archived. active is accepted on write as a legacy spelling of published.

string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string