elmo
Sign up

Update a brand

PATCH
/brands/{brandId}

Authorization

BearerAuth
headerAuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

Path Parameters

brandId*string

Brand identifier

Length1 <= length

Request Body

application/json
  1. body

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.

Properties1 <= properties
brandName?string
Length1 <= length
domains?array<string>

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

Items1 <= items
aliases?array<string>
enabled?boolean

Whether the brand is sampled at all. Modifiable only with an instance admin key: setting it with an organization key is a 403, because disabling ends tracking silently while the plan keeps being billed and no dashboard control does it at any role.

Response Body

Brand updated

application/json
  1. response
id*string

User-supplied brand identifier (e.g. "acme")

name*string
domains*array<string>

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

aliases*array<string>
enabled*boolean
onboarded*boolean
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
organizationId*string

The organization that owns this brand and is billed for it.

enabledModels*array<string>|

Models this brand is tracked on. Null means the deployment default.

delayOverrideHours*|

Sampling cadence override in hours. Null means the plan cadence.

Example Request
curl -X PATCH 'https://app.elmohq.com/api/v1/brands/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "string",
  "name": "string",
  "domains": [
    "string"
  ],
  "aliases": [
    "string"
  ],
  "enabled": true,
  "onboarded": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "organizationId": "string",
  "enabledModels": [
    "string"
  ],
  "delayOverrideHours": 0
}