Skip to main content
PATCH
Set Brand Visibility

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

advertiser_id
string<uuid>
required

Body

application/json

Body for PATCH /admin/brand-library/brands/{id}/visibility.

library_visibility is spelled as a Literal rather than validated against LIBRARY_VISIBILITY_VALUES at runtime so FastAPI rejects an unknown value with a 422 naming the allowed ones, before any handler code or row lock. The two are pinned to each other by LIBRARY_VISIBILITY_LITERAL_VALUES below, so a future third visibility cannot be added to the model without this contract noticing.

force only ever matters when flipping a UOB/DOB row TO public — the one direction that can expose a tenant's private own-brand record to every other tenant's browse surfaces. It is deliberately not a query parameter: an override that widens who can see a customer's data should have to be written into a request body, not appended to a URL that ends up in a log or a browser history entry.

library_visibility
enum<string>
required
Available options:
public,
tenant_private
force
boolean
default:false

Response

Successful Response

What the visibility flip actually left on the row.

Returns the stored value rather than echoing the request so the client applies what the server committed — including on the no-op path, where the row was already at the requested visibility and nothing was written.

advertiser_id
string<uuid>
required
library_visibility
string
required
changed
boolean
required
forced
boolean
default:false