Skip to main content
POST
/
global-brands
Create Global Brand
curl --request POST \
  --url https://api.peec.ai/customer/v1/global-brands \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Nike",
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'
{
  "id": "019ecb6e-d030-7222-b531-b371fe9db583",
  "name": "Nike"
}

Authorizations

​
X-API-Key
string
header
required

Body

​
name
string
required

The brand name.

Minimum string length: 1
Example:

"Nike"

​
project_id
string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

Response

The brand

The brand

​
id
string<uuid>
required

The global_brand_id — pass this as a product's brand when creating products.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"019ecb6e-d030-7222-b531-b371fe9db583"

​
name
string
required

The brand's canonical name. May differ slightly from the name you sent, since an existing brand is reused where one is found.

Example:

"Nike"