Brands API reference

List brands

GET /v1/brands

Optional query parameters:

Response:

{
  "data": [
    {
      "id": "brand_123",
      "name": "NexusCore Retail",
      "timezone": "America/New_York",
      "status": "active"
    }
  ],
  "next_cursor": null
}

Retrieve brand details

GET /v1/brands/{brand_id}

Returns configuration flags, SLA policies, allowed channels, and created timestamps.

Create a brand

POST /v1/brands

Body:

{
  "name": "Support EU",
  "timezone": "Europe/Berlin",
  "default_language": "de",
  "sla_policies": [
    {
      "name": "Priority",
      "response_minutes": 30,
      "resolution_minutes": 180
    }
  ]
}

Update a brand

PATCH /v1/brands/{brand_id}

Editable fields include:

• name
• status (active, paused)
• default_language
• sla_policies
• escalation_contacts

Manage brand memberships

POST /v1/brands/{brand_id}/members

Add an existing user to a brand with a role:

{
  "user_email": "lead@example.com",
  "role": "lead"
}

Remove access:

DELETE /v1/brands/{brand_id}/members/{user_id}

SLA policies

SLA objects include response_minutes, resolution_minutes, and optional hours_of_operation windows. Policies can be assigned to queues or intents.

Webhook tie-ins

Subscribe to brand.updated when integrating with third-party systems to detect configuration changes.

Refer to the OpenAPI spec for full schema definitions and error responses.