Skip to content

Consent

consent_providers_update

Update an existing consent provider.

Tool

Update an existing consent provider.

Update an existing consent provider. cookies: undefined leaves cookies unchanged, [] clears them, [...] replaces the whole set. privacyUrl: null clears the field.

HTTP
PATCH /consent/consent/providers/:id

Arguments

NameTypeRequiredDescription
idstringProvider id
namestringNo description in the catalog.
hostsarrayIf provided, REPLACES the hosts list. Omit to leave unchanged.
cookiesarrayIf provided, REPLACES the whole cookies set for this provider. Omit to leave unchanged.
categorystringConsent category bucket — matches CHECK constraint on consent_providers.category
orderIndexintegerNo description in the catalog.
privacyUrlstringnull clears the field, undefined leaves it unchanged
descriptionstringPass empty string to clear; undefined leaves unchanged

Response

FieldTypeAlwaysDescription
idstring
namestring
hostsarray
cookiesarray
categorystring
isSystemboolean
createdAtstring
updatedAtstring
catalogKeystring
orderIndexinteger
privacyUrlstring
descriptionstring

Try it

Update an existing consent provider.

When to use

Update an existing consent provider. cookies: undefined leaves cookies unchanged, [] clears them, [...] replaces the whole set. privacyUrl: null clears the field.

Example

Ask your agent something like this:

Update an existing consent provider.

The agent will invoke consent_providers_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect