Instances

Update Instance

put/v1/instances/{id}

Path parameters

idstring required

Example:in_000000000000

Headers

Idempotency-Keystring

Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

namestring required

customer_invite_redirect_urlstring uri nullable

email_notificationsboolean

Whether email notifications are enabled for this instance

require_passkeyboolean

Whether passkey verification is required for protected actions

compliance_emailsstring[] nullable

When non-empty, compliance Request for Information emails are sent only to these addresses instead of all instance members

customer_rfi_emails_enabledboolean

Whether customer (customer) Request for Information notification emails are sent for this instance. Omit to leave unchanged.

Example request

{
  "name": "My Instance",
  "customer_invite_redirect_url": "https://blindpay.com",
  "email_notifications": true,
  "compliance_emails": [
    "compliance@example.com"
  ],
  "customer_rfi_emails_enabled": true
}

Response

Instance updated

successboolean required

Example response

{
  "success": true
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.