Instances

Update Instance

Changed on
put/v1/instances/{id}

Request

  • Base URL: https://blindpay.com (the document declares no server; this is the origin it was published from)
  • URL: https://blindpay.com/v1/instances/{id}
  • Auth: HTTP bearer

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
logo_urlstring uri nullable

Logo shown to your customers on hosted pages such as the Terms of Service acceptance page

accent_colorstring nullable

Accent color applied to hosted pages such as the Terms of Service accept button

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

partner_tos_linkstring uri nullable

Passthrough Terms of Service: the page where your customers are presented with the BlindPay Terms of Service

partner_tos_screenshotstring uri nullable

Passthrough Terms of Service: a screenshot of how the BlindPay Terms of Service are displayed to your customers. Must be a file_url returned by POST /upload with bucket documents.

customer_rfi_emails_enabledboolean

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

partner_tos_terms_acceptedtrue

Passthrough Terms of Service: accept the current Passthrough Terms of Service Partner Agreement (https://blindpay.com/passthrough-tos-partner-agreement). Dashboard users only; requires partner_tos_link and partner_tos_screenshot.

Example request

{
  "name": "My Instance",
  "customer_invite_redirect_url": "https://blindpay.com",
  "logo_url": "https://files-avatar.blindpay.com/in_000000000000/logo.jpg",
  "accent_color": "#1d4ed8",
  "email_notifications": true,
  "compliance_emails": [
    "compliance@example.com"
  ],
  "partner_tos_link": "https://example.com/sign-up",
  "partner_tos_screenshot": "https://files-documents.blindpay.com/1790000000000-tos-screenshot.png",
  "customer_rfi_emails_enabled": true,
  "partner_tos_terms_accepted": true
}

Response

Instance updated

successboolean required

Example response

{
  "success": true
}

Changes

  • e95485a80ccbRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • eed10f8d151bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property