Relabel or relink a brand library image

Renames a library image, changes which identifiers it is linked to, or both. Send at least one of label or linkTo, otherwise the call is refused. Requires an Enterprise subscription and the brand image library enabled for the tenant.

linkTo is the FULL desired set of identifiers for this image, not an addition: identifiers in the list that are not already linked are linked, and identifiers currently linked that are absent from the list are unlinked. Each link and unlink is applied individually and the call stops at the first refusal (409 for the 3-per-identifier cap, 400 for an identifier that no longer exists), so a PARTIAL set may already have been applied when an error is returned - which is why the success response returns the image read back fresh. Re-read it and retry with the set you want.

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

The image's content address, from list-brand-images.

string

New label. Cleaned and truncated to 60 characters.

linkTo
array of strings

The complete set of identifierIDs this image should be linked to. An empty array unlinks it from everything.

linkTo
Responses

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