Skip to content

Consent

consent_config_customization_upsert

Fine-tunes the banner beyond brand tokens, when the theme alone is not enough.

Tool

Fine-tunes the banner beyond brand tokens, when the theme alone is not enough.

Fine-tunes the banner beyond brand tokens, when the theme alone is not enough. logoUrl / coverUrl — https URLs to images hosted on the client's side (we store nothing; an empty string removes the asset; an external URL exposes the visitor's IP to that host); coverUrl is a header strip across the top of the banner. position — where the banner sits on the page ("bottom" / "top" / "bottom-left" / "bottom-right" / "center-modal"); this is the banner's placement, distinct from the reopen-icon corner in consent_config_floating_icon_upsert. logoAlign — "start" / "center" / "end"; contentAlign — "start" / "center". All fields are optional and patch-merge onto the previous customization. This layer does not change button equality ("Accept all" / "Reject all") or the provider list.

HTTP
PATCH /consent/config/customization

Arguments

NameTypeRequiredDescription
logoUrlstringNo description in the catalog.
coverUrlstringNo description in the catalog.
positionstringNo description in the catalog.
logoAlignstringNo description in the catalog.
contentAlignstringNo description in the catalog.

Response

FieldTypeAlwaysDescription
customizationobject
customizationInputobject

Try it

Fine-tunes the banner beyond brand tokens, when the theme alone is not enough.

When to use

Fine-tunes the banner beyond brand tokens, when the theme alone is not enough. logoUrl / coverUrl — https URLs to images hosted on the client's side (we store nothing; an empty string removes the asset; an external URL exposes the visitor's IP to that host); coverUrl is a header strip across the top of the banner. position — where the banner sits on the page ("bottom" / "top" / "bottom-left" / "bottom-right" / "center-modal"); this is the banner's placement, distinct from the reopen-icon corner in consent_config_floating_icon_upsert. logoAlign — "start" / "center" / "end"; contentAlign — "start" / "center". All fields are optional and patch-merge onto the previous customization. This layer does not change button equality ("Accept all" / "Reject all") or the provider list.

Example

Ask your agent something like this:

Fine-tunes the banner beyond brand tokens, when the theme alone is not enough.

The agent will invoke consent_config_customization_upsert with these arguments:

{}

Esc

Start typing to search the docs.

navigateselect