Skip to content

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

Name
Type
Required
Description
logoUrl
string
—
No description in the catalog.
coverUrl
string
—
No description in the catalog.
position
string
—
No description in the catalog.
logoAlign
string
—
No description in the catalog.
contentAlign
string
—
No description in the catalog.

Response

Field
Type
Always
Description
customization
object
•
customizationInput
object
•

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.

↑↓navigate↵select