Skip to content

Add brand

AddBrand

Description: Adds a new brand configuration to the platform. The brand includes UI assets and domain host configuration. It is used to differentiate environments or white-label setups.

Access Control

🛡️ Access Level Required: SESSION_ADMIN


Request Parameters

Name Type Required Description
brand string Yes Brand name (1–64 characters)
dark_logo string Yes Path or URL to the dark logo (1–128 chars)
light_logo string Yes Path or URL to the light logo (1–128 chars)
favicon string Yes Path or URL to the favicon (1–128 chars)
terminal_host string Yes Host URL for terminal access
crm_host string Yes Host URL for CRM
status int Yes Status flag (e.g., 1 for active, 0 for off)

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",
  "status": 1
}

Response Example

{
  "data": "OK"
}

Error Example

{
  "error": "BRAND_ADD_ERROR",
  "message": "Could not create brand record"
}