Skip to main content
PUT
Set your white-label branding
Set your desk’s white-label branding. Any valid key may write (no scope required); a broker edits only its own record. The body is a partial update: send the fields you want to change. Returns the updated record. Every field is validated so a stored value can never become an injection vector on a page that renders it:
  • URLs (logo_url, support_url) must be https:// and length-capped. http:, javascript: and data: are rejected with 400.
  • accent_color must be a hex colour like #4F7CFF; anything else is rejected (it lands in CSS).
  • Text fields are trimmed and length-capped.

Request example

Response example

Errors

  • 400 bad_request, a non-https URL or a malformed accent_color.
  • 401 / 429, the standard auth errors.
Terms used here: IEC, API key, scope. Full list in the terminology annexure.

Next steps

Authorizations

X-ScripX-Key
string
header
required

Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.

Body

application/json
brand_name
string
logo_url
string<uri>

https only

support_email
string
support_url
string<uri>
accent_color
string
Example:

"#4F7CFF"

Response

OK

branding
object