Skip to content
XOS Developers

orgBrandings

Settings module · 5 operations

List org branding rows

GET/org-branding

White label brand settings for Atlas, Gateway, email and Compass. Returns a cursor page of org branding rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an org branding

POST/org-branding

White label brand settings for Atlas, Gateway, email and Compass. Creates an org branding. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get an org branding

GET/org-branding/{id}

White label brand settings for Atlas, Gateway, email and Compass. Returns one org branding with its `ETag`. A org branding the caller may not see returns 404.

Update an org branding

PATCH/org-branding/{id}

White label brand settings for Atlas, Gateway, email and Compass. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete an org branding

DELETE/org-branding/{id}

White label brand settings for Atlas, Gateway, email and Compass. Soft-deletes the org branding: it moves to Trash and can be restored for its table's retention period.