Actions format
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
actions
property of server response is optional.
Use this response to add a tag to a subscriber. Tag with the same name must exist in your bot:
{
"version": "v1",
"content": {
"messages": [
{
"type": "text",
"text": "simple text with button",
"buttons": [
{
"type": "url",
"caption": "External link",
"url": "https://rapidbott.com"
}
]
}
],
"actions": [
{
"action": "add_tag",
"tag_name": "your tag",
}
],
"quick_replies": []
}
}
Tag name sent using tag_name
parameter should match one of existing tags within Rapidbott bot
Use this response to remove a tag from a subscriber. Tag with the same name must exist in your bot:
{
"version": "v1",
"content": {
"messages": [
{
"type": "text",
"text": "simple text with button",
"buttons": [
{
"type": "url",
"caption": "External link",
"url": "https://rapidbott"
}
]
}
],
"actions": [
{
"action": "remove_tag",
"tag_name": "your tag",
}
],
"quick_replies": []
}
}
Use this response to set subscriber’s field value. Custom field with the same name must exist in your bot
{
"version": "v1",
"content": {
"messages": [
{
"type": "text",
"text": "simple text with button",
"buttons": [
{
"type": "url",
"caption": "External link",
"url": "https://rapidbott.com"
}
]
}
],
"actions": [
{
"action": "set_field_value",
"field_name": "your field name",
"value": "some value"
}
],
"quick_replies": []
}
}
Filed name sent using field_name
should match with name of one of custom fields existing within Rapidbott bot You need to control data type recorded in custom fields, data type should match type of custom field
Use following value formats:
For Number
field type value should be numeric like 2
or 3.14
not bounded by double quotation marks;
For Text
field type value should be transferred as text "some text"
;
For Date
field type value should be transferred as text with date formatted like YYYY-MM-DD
, i.e. "2018-03-25"
;
For Date Time
field type value should be transferred as text with date formatted in ISO8601 UTC, i.e "2018-03-25T13:25:00.000Z"
Use this response to unset (clear) subscriber’s field value. Custom field with the same name must exist in your bot
{
"version": "v1",
"content": {
"messages": [
{
"type": "text",
"text": "simple text with button",
"buttons": [
{
"type": "url",
"caption": "External link",
"url": "https://rapidbott.com"
}
]
}
],
"actions": [
{
"action": "unset_field_value",
"field_name": "your field name"
}
],
"quick_replies": []
}
}