Update the webhook URL, display name and branding colors

PATCH/settings

Set or clear the webhook endpoint URL that receives event deliveries, the customer-facing display name, and/or the checkout background/primary brand colors. Pass null for webhook_url to disable webhooks, or for display_name/background_color/primary_color to fall back to the default. Each color applies independently — whichever is unset falls back to the platform default. Omitted fields are left unchanged; only a first-time webhook_url configuration also returns webhook_secret.

Headers

Header	Description	Required
Authorization	Bearer token with your secret API key	yes

Request Body

Field	Type	Required
webhook_url	string \| null	—
display_name	string \| null	—
background_color	string \| null	—
primary_color	string \| null	—

Example Request

Request

const response = await fetch('https://checkout-api.exodus-int.com/settings', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "webhook_url": "https://yoursite.com/webhooks/exodus",
    "display_name": "Acme Inc.",
    "background_color": "#0f172a",
    "primary_color": "#7c3aed"
  }),
});

Responses

Status	Description
200	The updated settings.
400	Validation error
401	Missing or invalid authentication
403	API key lacks the required scope

Response body

Field	Type	Required
webhook_url	string \| null	yes
display_name	string \| null	—
background_color	string \| null	—
primary_color	string \| null	—
webhook_secret	string	—

Example Response

{
  "webhook_url": "https://yoursite.com/webhooks/exodus",
  "display_name": "Acme Inc.",
  "background_color": "#0f172a",
  "primary_color": "#7c3aed"
}

Error Response

Error (e.g. 400)

{
  "error": {
    "type": "validation_error",
    "message": "amount must be a positive number",
    "param": "amount"
  }
}

Update the merchant settlement address Send a test webhook delivery