Skip to main content
POST
Submit a built version of a mini app
The acting user must have mini-apps:write. An empty editor list allows everyone with that permission. When the list is nonempty, only selected editors and the owner can edit. Admins must also satisfy the editor restriction. Bare API keys and users excluded by a restricted list receive 403. An invited user who loses edit permission cannot submit changes. See Mini-app editing access for invitations, ownership transfer, and the difference between viewing and editing.

Authorizations

Authorization
string
header
required

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

Body

application/json
app_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
source
string
required
Minimum string length: 1
code
string
required
Minimum string length: 1
css
string
required
target_surface
enum<string>
Available options:
inbox,
dashboard
declared_network
object[]
Maximum array length: 20
template
string
Maximum string length: 100
template_version
string
Maximum string length: 100

Response

Default Response

app_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
version_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
version
string
required