Sign in

v2

latestOpenAPI 3.0.32026-08-05174296703.4 KB
ops

updateBranding branding

Update a branding config

put/ops/branding/{branding_id}

Path parameters

branding_idstring required

ID of the branding config to update

Example:abc123

ID of the branding config to update

Request body

Example request

{
  "branding": {
    "email_logo_url": "abc123",
    "enable_transactional_emails": false,
    "info_hub_url": "abc123",
    "logo_url": "abc123",
    "name": "abc123"
  }
}

Response

OK response.

created_atstring date-time required
email_logo_urlstring

Url for the logo to display in emails, if any

enable_transactional_emailsboolean required

Whether or not to enable transactional emails

idstring regexp required

ID of branding config

info_hub_urlstring

Url for the info hub, if any

logo_urlstring

Url for the logo to display, if any

namestring required

Name of the branding config

updated_atstring date-time required

Example response

{
  "created_at": "1970-01-01T00:00:01Z",
  "email_logo_url": "abc123",
  "enable_transactional_emails": false,
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "info_hub_url": "abc123",
  "logo_url": "abc123",
  "name": "abc123",
  "updated_at": "1970-01-01T00:00:01Z"
}