Skip to content

Read Display Condition Capabilities

Tool name: get-email-editor-display-condition-capabilities

Reads what a display condition may say in one account -- the vocabulary behind "dynamic content", where a row is shown only to the contacts a condition selects. Without conditionTypes it answers the catalogue alone: every kind of condition, such as manual tag, SmartLink, automation or newsletter. With conditionTypes it adds, for those kinds, the comparisons they allow, this account's own entities with the smart-tag field per action, the actions and the timeframes -- the exact values update-email-editor-display-condition takes as condition, entity, action and timeframe. Entities are cut at 200 per kind and entityCount says how many there are. Reads only.

Input schema

conditionTypesArray of strings, <= 5 items

Kinds to read the field values of, as conditionType of the catalogue; omit for the catalogue alone

Default:null
accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{ "conditionTypes": null, "accountId": null }

Output schema

accountIdintegerrequired
conditionTypesArray of objectsrequired
detailsArray of objectsrequired
Output example
{ "accountId": 0, "conditionTypes": [ { "conditionType": "string", "label": "string", "group": "string" } ], "details": [ { "conditionType": "string", "conditions": [ { "condition": "string", "label": "string", "op": "string", "needsEntity": true } ], "entities": [ { "entity": 0, "label": "string", "actionFields": {} } ], "entityCount": 0, "actions": [ { "action": "string", "label": "string" } ], "timeframes": [ { "timeframe": "string", "label": "string", "value": 0 } ] } ] }