v1Resources/Clients/patchUpdate client portal branding

Update client portal branding

Read or replace the client portal logo, color, favicon and logo tone as a whole bundle. Set customized=false to clear all overrides and inherit agency defaults. Requires an identified agency user with Clients access and access to this client; credential client restrictions also apply.

patch/api/v1/clients/{id}/portal-brand
clients:write
Query parameters
idstringrequired
Request body
customizedbooleanrequired
logoUrlstringoptional
faviconUrlstringoptional
colorHexstringoptional
logoTonestring (dark | light | original)optional
Response
dataobjectrequired
customizedbooleanoptional
overrideobjectoptional
logoUrlstringoptional
colorHexstringoptional
faviconUrlstringoptional
logoTonestring (dark | light | original)optional
masterobjectoptional
logoUrlstringoptional
colorHexstringoptional
faviconUrlstringoptional
logoTonestring (dark | light | original)optional
effectiveobjectoptional
logoUrlstringoptional
colorHexstringoptional
faviconUrlstringoptional
logoTonestring (dark | light | original)optional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Retry a credit grant with the same idempotency key.
patch/api/v1/clients/{id}/portal-brand
Your API key
id *
Request body*
{}

Guides that use this resource