Skip to content

Add brand

AddBrand

Description: Creates a brand configuration.

Access Control

SESSION_ADMIN

HTTP Route

POST /brand

Request Parameters

Name Type Required Description
brand string Yes Brand name
dark_logo string Yes Dark logo path or URL
light_logo string Yes Light logo path or URL
favicon string Yes Favicon path or URL
terminal_host string Yes Terminal host
crm_host string Yes CRM host
enable int Yes Enable flag, 0 or 1
settings object No Additional brand settings object

Request Example

{
  "brand": "IonMarkets",
  "dark_logo": "/images/ion-dark.svg",
  "light_logo": "/images/ion-light.svg",
  "favicon": "/images/favicon.ico",
  "terminal_host": "terminal.ionmarkets.com",
  "crm_host": "crm.ionmarkets.com",
  "enable": 1,
  "settings": {
    "primary_color": "#111111"
  }
}

Response Example

{
  "data": "OK"
}

Error Examples

{
  "error": "INVALID_DATA",
  "message": "enable must be between 0 and 1"
}
{
  "error": "BRAND_ADD_ERROR",
  "message": "..."
}