Create a brand
POST /api/brands
Creates a brand. The call is safe to retry: when a brand with the same slug and name exists, it is returned with 200. Create workspaces under the brand with POST /api/workspaces. Requires the brands:write scope and an API key without a brand or workspace restriction.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
Brand name, as customers know it.
Example
Example CompanyShort identifier of lowercase letters, digits and hyphens, unique within the account. Fixed once the brand is created; the first brand of a new account, born with the placeholder slug new-account, takes a slug derived from its name on its first rename.
Example
example-companySender name on email sent for this brand.
Example
Example CompanyAn inactive brand is paused. Defaults to ‘active’.
Https URL of the brand logo, shown at the top of emails. Upload a file with POST /api/brands/{brandId}/logo instead.
Primary brand colour.
Secondary brand colour.
The assistant’s personality for this brand.
Instructions the assistant follows in every conversation of this brand.
Name the assistant signs with.
Title the assistant signs with.
Language codes this brand operates in. Workspaces of the brand choose their operating language from this set.
Default language; one of supportedLanguages.
Responses
Section titled “ Responses ”A brand with this slug and name exists; it is returned.
A brand: how customers know the business. Workspaces sit under a brand.
object
The account the brand belongs to.
Example
Example CompanyExample
example-companyExample
Example CompanyThe assistant’s voice per language on voice channels.
object
The brand was created.
A brand: how customers know the business. Workspaces sit under a brand.
object
The account the brand belongs to.
Example
Example CompanyExample
example-companyExample
Example CompanyThe assistant’s voice per language on voice channels.
object
The caller may not change brands. People need the owner or admin role. An API key needs the brands:write scope; a key restricted to a brand or workspace receives code: "key_lock" for an action its restriction does not cover.
Standard error response returned by all endpoints on failure.
object
A human-readable error message describing what went wrong.
Example
Conversation not foundA machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.
Example
key_lockOn a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.
Example
[ "mcp:write"]On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.
Example
11223344-5566-4788-99aa-bbccddeeff00On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.
On the same 422: the tool names the connection does not declare.
Example
[ "get_orders"]On the same 422: the tools the connection declares.
Example
[ "get_order", "search_orders"]A different brand in the account holds this slug. The body names it.
The slug belongs to a different brand in the account.
object
Example
A brand with this slug already existsThe brand that holds the slug.
Validation error. One or more fields are missing or invalid; logoUrl must use https.
Standard error response returned by all endpoints on failure.
object
A human-readable error message describing what went wrong.
Example
Conversation not foundA machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.
Example
key_lockOn a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.
Example
[ "mcp:write"]On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.
Example
11223344-5566-4788-99aa-bbccddeeff00On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.
On the same 422: the tool names the connection does not declare.
Example
[ "get_orders"]On the same 422: the tools the connection declares.
Example
[ "get_order", "search_orders"]A new voice in personaVoice could not be checked because the voice list could not be read. Nothing was written; retry the request.
Standard error response returned by all endpoints on failure.
object
A human-readable error message describing what went wrong.
Example
Conversation not foundA machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.
Example
key_lockOn a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.
Example
[ "mcp:write"]On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.
Example
11223344-5566-4788-99aa-bbccddeeff00On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.
On the same 422: the tool names the connection does not declare.
Example
[ "get_orders"]On the same 422: the tools the connection declares.
Example
[ "get_order", "search_orders"]