PATCH /update-app/{app_id}

Changed on

Partially update an App. Omitted fields remain unchanged. Updating auth_config or tenant metadata invalidates the cached provider token immediately. OAuth-only providers reject auth_config and must be reauthorized through connect-app. Providers supporting caller-managed credentials as well, such as Cal.com, continue to accept those credentials.

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Path parameters

app_idstring required

Request body

namestring
tenant_urlstring

Per-tenant API base URL.

tenant_idstring

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

Response

Updated App.

app_idstring required
org_idstring required
type'crm' | 'calendar' | 'knowledge_base' | 'support' | 'communication' required

App integration category.

providerstring required

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

connection_status'not_connected' | 'connected' | 'error'

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).

namestring
tenant_urlstring

Per-tenant API base URL. Set by providers with per-org hosts; omitted by providers on a single global host. For OneDrive for Business, this is the tenant's -my.sharepoint.com origin used by File Picker v8; personal OneDrive omits it.

tenant_type'business' | 'personal'

Microsoft OneDrive account type discovered during OAuth.

tenant_idstring

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

created_timestampnumber required
user_modified_timestampnumber required

Changes