elmo
Get Started

Update a brand

PATCH
/brands/{brandId}

Authorization

BearerAuth
AuthorizationBearer <token>

Bearer API token for access

In: header

Path Parameters

brandId*string

Brand identifier

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Update brand-level fields. At least one field must be provided. Provided arrays replace the stored values verbatim. When domains is provided, the first entry becomes the primary website and the rest become additional domains. Prompts and competitors are managed via /prompts and /competitors.

brandName?string
domains?array<string>

Brand domains. The first entry is the primary website; remaining entries are additional domains.

aliases?array<string>
enabled?boolean

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/brands/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "domains": [    "string"  ],  "aliases": [    "string"  ],  "enabled": true,  "onboarded": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
{  "error": "string",  "message": "string"}
{  "error": "string",  "message": "string"}
{  "error": "string",  "message": "string"}
{  "error": "string",  "message": "string"}