Create a brand tag

POST /manager/brand-tags

Bearer token

application/json

Body

visibility_chat number

Values are 1 or 2.
images array[object]
Hide images attributes Show images attributes object
- lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
- content string
names array[object]
Hide names attributes Show names attributes object
- lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
- content string

Responses

201 application/json

returns the created brand tag
Hide response attributes Show response attributes object
- id_brand_tag integer(int32)
- visibility_chat integer
- name string
- image string
- images array[object]
  
  Hide images attributes Show images attributes object
  
  id_i18n_content integer
  
  lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
  
  content string
- names array[object]
  
  Hide names attributes Show names attributes object
  
  id_i18n_content integer
  
  lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
  
  content string
- members object
  
  Additional properties are allowed.
  
  Hide members attributes Show members attributes object
  
  id_ambassador integer(int32)
  
  image string
  
  firstname string
  
  lastname string
  
  username string
  
  email string
  
  email_tmp string
  
  active integer(int32)
  
  status integer(int32)
  
  online boolean
  
  true: when last_action_date is less than 5 minutes ago
  
  last_action_date string(date-time)
  
  customer_id string
  
  anonymized boolean
401 application/json

Unauthorized.
Hide response attribute Show response attribute object
- message string
403

Forbidden - You don't have permission to access this route
422 application/json

Unprocessable Content
Hide response attributes Show response attributes object
- message string
  
  Error message.
- errors object
  
  Hide errors attributes Show errors attributes object
  
  field array[string]
  
  Error message details.
  
  * array[string] Additional properties
  
  Error message details.

POST /manager/brand-tags

curl \
 --request POST 'https://domain.tld/api/v2/manager/brand-tags' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"visibility_chat":1,"images":[{"lang":"en_GB","content":"Hello"}],"names":[{"lang":"en_GB","content":"Hello"}]}'

Request examples

{
  "visibility_chat": 1,
  "images": [
    {
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "names": [
    {
      "lang": "en_GB",
      "content": "Hello"
    }
  ]
}

Response examples (201)

{
  "id_brand_tag": 42,
  "visibility_chat": 0,
  "name": "groupe",
  "image": "https://superimage.com",
  "images": [
    {
      "id_i18n_content": 42,
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "names": [
    {
      "id_i18n_content": 42,
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "members": {
    "id_ambassador": 42,
    "image": "string",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "email": "string",
    "email_tmp": "string",
    "active": 42,
    "status": 42,
    "online": true,
    "last_action_date": "2025-05-04T09:42:00Z",
    "customer_id": "string",
    "anonymized": true
  }
}

Response examples (401)

{
  "message": "Unauthorized."
}

Response examples (422)

{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}