Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

application/json
type
enum<string>
required

App integration category.

Available options:
crm,
calendar,
knowledge_base,
support,
communication
provider
string
required

Provider name. Must be valid for the App's type; the supported providers per type are listed by list-app-templates.

name
string

Display name.

tenant_url
string

Per-tenant API base URL.

tenant_id
string

Sub-account id, for providers that scope requests by a sub-account id on a shared host.

auth_config
object
crm_config
object

Response

App created.

app_id
string
required
org_id
string
required
type
enum<string>
required

App integration category.

Available options:
crm,
calendar,
knowledge_base,
support,
communication
provider
string
required

Provider name. Must be valid for the App's type; the supported providers per type are listed by list-app-templates.

created_timestamp
number
required
user_modified_timestamp
number
required
connection_status
enum<string>

Connection health of the App, server-managed. not_connected after create or a credential / tenant URL change; connected once verified via OAuth connect, an auth test, or a successful live tool call; error when the provider rejects the credentials (on connect, an auth test, or a live tool call).

Available options:
not_connected,
connected,
error
name
string
tenant_url
string

Per-tenant API base URL. Set by providers with per-org hosts; omitted by providers on a single global host.

tenant_id
string

Sub-account id, for providers that scope requests by a sub-account id on a shared host. Omitted by every other provider.

auth_config
object

Non-secret auth metadata. Encrypted secret fields are never returned by the API.

crm_config
object