Skip to main content
POST
create-external-app

Authorizations

Authorization
string
header
required

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

Body

application/json
key
string
required

Machine key (e.g., "attio"). Unique per workspace.

Minimum string length: 1
name
string
required

Human-readable app name (e.g., "Attio").

Minimum string length: 1
appUri
string<uri>

App's main URL (e.g., "https://attio.com").

logoUri
string<uri>
categories
string[]

[INTERNAL] Categorization tags used by the Universe catalog.

defaultConnectorId
string

[INTERNAL] Connector ID surfaced as the default for this app in the Universe catalog.

basePackageId
string

[INTERNAL] Base package ID this app is derived from.

hasFreeTestAccount
boolean | null

[INTERNAL] Whether the app has a free test account.

freeTestAccountGuide
string

[INTERNAL] Guide for obtaining a free test account.

freeTestAccountGuideVerifiedAt
string<date-time> | null

[INTERNAL] When the free test account guide was last verified.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
tenantId
string

Response

200 - application/json

Create a new private app. Only use this if list-external-apps found no matching public app.

id
string
required
key
string
required
name
string
required
uuid
string
isReadOnly
boolean
isPublic
boolean
{key}
any