Set colours and theme

Set the colours and theme options used across the branded experience, and optionally replace the account's logo. Send JSON for theme options only, or multipart/form-data with logo_image. The response has the saved theme plus the account's white-label record, with image fields as full URLs.

Prerequisites: a bearer token, the company_id of the account you're theming, and your user id (user_id). To upload a logo: a JPEG or PNG up to 400 KB.

Authentication: Partner or Account token. company_id must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise 422. user_id is recorded as who saved the theme; send your own.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 3011

Your user id, recorded as who saved the theme. Must be an existing user.

integer
required
Defaults to 5994

The account to theme. Must exist and be inside your account tree.

string
required
Defaults to {"mode":"system","primaryColor":"#f1874c"}

The theme settings as a JSON-encoded string, e.g. {"mode":"system","primaryColor":"#f1874c"}. Saved as sent and returned unchanged.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json