v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB

Backend

Update Partner Backend

patch/partner/backends/{id}

Path parameters

idstring required

Unique Backend ID

Request body

namestring

Human-readable label for the backend.

auth_typestring

One of manual, automatic_redirect, automatic_headless.

activation_typestring

One of instant, partner_activate, practice_activate.

redirect_urlstring

OAuth redirect URL invoked after authorization_code issuance.

localhost_redirect_urlstring

HTTP localhost URL used in place of redirect_url when the requesting browser session has localhost mode enabled. Sandbox partners only.

localhost_webhook_urlstring

HTTP localhost URL the browser proxies this backend's webhook deliveries to when localhost mode is enabled. Sandbox partners only.

webhooks_disabledboolean

Disables webhook delivery for this backend's endpoints.

webhooks_pausedboolean

Pauses webhook delivery for this backend's endpoints.

unmute_self_webhooksboolean

Delivers webhooks for events triggered by this backend's own requests.

max_requests_per_minuteinteger

Webhook delivery rate ceiling for this backend.

listened_eventsstring[]

Event types delivered to this backend's endpoints.

webhooks_signature_api_keyobject

The partner-owned api key whose secret signs this backend's webhooks. Pass { "id": "<api key id>" }.

api_credentials_configurationobject

The backend's API-publishing configuration. Accepts spec_url, docs_url, issuance_mode (push/pull), exchange_url, and call_path (proxy/direct).

Response

Successful response

idstring

activation_typestring

auth_typestring

created_atstring

listened_eventsstring

localhost_redirect_urlstring

localhost_webhook_urlstring

max_requests_per_minutestring

namestring

redirect_urlstring

unmute_self_webhooksstring

updated_atstring

webhooks_disabledstring

webhooks_pausedstring