Add an image to the brand library

Adds a logo or brand asset to the tenant's image library and optionally links it to identifiers. Requires an Enterprise subscription and the brand image library enabled for the tenant (otherwise 403 with ErrorCode FEATURE_DISABLED).

Supply the bytes ONE of two ways - exactly one of dataBase64 or imageUrl, never both and never neither (400, ErrorCode MISSING_REQUIRED_FIELD). Prefer imageUrl when the logo is already published on the customer's own site; the URL must be https and is fetched through an SSRF guard, so private and internal addresses are refused.

Images must be PNG or JPEG, 4 MB or smaller, at least 64 px on the short edge and at most 4096 px on the long edge. The declared contentType must match what the bytes actually are - the file is sniffed and a mismatch is refused; any Content-Type returned by imageUrl is ignored for the same reason.

Images are content-addressed: imageID is the SHA-256 of the bytes, so uploading the same image twice does not duplicate it. The second call returns Existed: true and simply applies linkTo.

Up to 50 images per tenant and up to 3 per identifier; exceeding either returns 409. Get identifierIDs from list-brand-identifiers.

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

https URL of the image to fetch. Mutually exclusive with dataBase64. At most one redirect is followed, and only to a URL that also passes the SSRF guard. The download is aborted past 4 MB.

string

The raw image bytes, base64 encoded. Mutually exclusive with imageUrl. Oversized strings are refused without being decoded.

string
enum

Optional. When omitted the format sniffed from the bytes is used; when supplied it must match the sniffed format.

Allowed:
string

Optional human label. Cleaned and truncated to 60 characters; defaults to the file name from imageUrl, else "Image".

linkTo
array of strings

identifierIDs to link this image to. Each must already exist.

linkTo
Responses

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