List all personalization tags

Returns every personalization tag the account can use in campaign and automation content: the built-in tags for contacts, lists, campaigns, deals, accounts, ecommerce and custom objects, plus one tag per custom field. Categories the account is not entitled to (deals, accounts, ecommerce, custom objects) are omitted. categories maps each category code to its display label, returned as a translation key.

The catalog is not paginated: limit and offset are ignored and the response has no meta.

Ecommerce and custom object tags are read from the account's custom object schemas. If that read fails, any request that includes ECOMMERCE or CUSTOM_OBJECT (the unfiltered request does) returns 500 and no tags at all. To keep the rest of the catalog when this happens, request those two categories separately.

If an account's contact, deal or account custom fields cannot be read, the catalog still returns 200 and includes one placeholder tag for that category with type error and perstag %ERROR%.

Query Params
string

Only tags in this category code, a key of categories, for example CONTACT, CONTACT_CUSTOM, DEAL, LIST, CAMPAIGN. An unknown code returns no tags. Combined with filters[groups], the result is the union of both.

string

Comma-separated groups, or repeat filters[groups][]. SUBSCRIBER expands to CONTACT, SUBSCRIBER, SUBSCRIBER_GEO, SUBSCRIBER_DATE_TIME and CONTACT_CUSTOM; CUSTOMER_ACCOUNT to CUSTOMER_ACCOUNT and ACCOUNT_CUSTOM; DEAL to DEAL and DEAL_CUSTOM. Any other value is taken as a category code, and unknown values are ignored. Combined with filters[category], the result is the union of both.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json