Update Partner Backend

patch

https://api.sandbox.hint.com/api/partner/backends/{id}

Path Params

string

required

Unique Backend ID

Body Params

name

string

Human-readable label for the backend.

auth_type

string

One of manual, automatic_redirect, automatic_headless.

activation_type

string

One of instant, partner_activate, practice_activate.

redirect_url

string

OAuth redirect URL invoked after authorization_code issuance.

localhost_redirect_url

string

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

localhost_webhook_url

string

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

webhooks_disabled

boolean

Disables webhook delivery for this backend's endpoints.

webhooks_paused

boolean

Pauses webhook delivery for this backend's endpoints.

unmute_self_webhooks

boolean

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

max_requests_per_minute

int32

Webhook delivery rate ceiling for this backend.

listened_events

array of strings

Event types delivered to this backend's endpoints.

listened_events

webhooks_signature_api_key

object

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

api_credentials_configuration

object

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

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response