Skip to main content

BroadcastVariables

Where each template variable comes from: header and body by placeholder ("1", "2"… or the name), buttons by button index. Every contact or field source requires a fallback for whoever lacks the data. A media header needs headerMedia.

header object
property name* VariableSource

contact (a contact detail), attribute (a custom field) or static (a fixed value).

sourcestringrequired

Possible values: [contact, attribute, static]

keystring
Example: first_name
fallbackstring

Possible values: non-empty and <= 200 characters

valuestring

Possible values: non-empty and <= 1000 characters

body object
property name* VariableSource

contact (a contact detail), attribute (a custom field) or static (a fixed value).

sourcestringrequired

Possible values: [contact, attribute, static]

keystring
Example: first_name
fallbackstring

Possible values: non-empty and <= 200 characters

valuestring

Possible values: non-empty and <= 1000 characters

buttons object
property name* VariableSource

contact (a contact detail), attribute (a custom field) or static (a fixed value).

sourcestringrequired

Possible values: [contact, attribute, static]

keystring
Example: first_name
fallbackstring

Possible values: non-empty and <= 200 characters

valuestring

Possible values: non-empty and <= 1000 characters

headerMedia object
typestring

Possible values: [image, video, document]

linkstring<uri>

Possible values: <= 2000 characters

idstring

Possible values: <= 100 characters

filenamestring

Possible values: <= 240 characters

BroadcastVariables
{
"body": {
"1": {
"source": "contact",
"key": "first_name",
"fallback": "cliente"
},
"2": {
"source": "static",
"value": "BLACK20"
}
}
}