Skip to content
FlexiPedia logo

Actions format

Enhance your subscriber interactions with Flexito's powerful tagging and field management features. Whether you want to categorise users with tags or manage their custom field values, these actions streamline your bot's functionality, ensuring personalised and efficient communica

Flexito OmniAI
Beginnerv4
Read in:

Listen to an audio overview

A short, AI-generated podcast-style summary of this article.

Enhance your subscriber interactions with Flexito's powerful tagging and field management features. Whether you want to categorise users with tags or manage their custom field values, these actions streamline your bot's functionality, ensuring personalised and efficient communication.

The server response's actions property is not mandatory.

Add a Tag to a Subscriber

This response allows you to add a tag to a subscriber. Ensure the tag already exists in your bot:

{ "version": "v1", "content": { "messages": [ { "type": "text", "text": "simple text with button", "buttons": [ { "type": "url", "caption": "External link", "url": "" } ] } ], "actions": [ { "action": "add_tag", "tag_name": "your tag", } ], "quick_replies": [] } } The tag name provided in the tag_name parameter must match one of the existing tags in the Flexito OmniAI bot.

Remove a Tag from a Subscriber

This response enables you to remove a tag from a subscriber. Ensure the tag already exists in your bot:

{ "version": "v1", "content": { "messages": [ { "type": "text", "text": "simple text with button", "buttons": [ { "type": "url", "caption": "External link", "url": "" } ] } ], "actions": [ { "action": "remove_tag", "tag_name": "your tag", } ], "quick_replies": [] } }

Set a Subscriber's Field Value

This response allows you to set a subscriber's field value. Ensure the custom field already exists in your bot.

{ "version": "v1", "content": { "messages": [ { "type": "text", "text": "simple text with button", "buttons": [ { "type": "url", "caption": "External link", "url": "" } ] } ], "actions": [ { "action": "set_field_value", "field_name": "your field name", "value": "some value" } ], "quick_replies": [] } } The field name provided in the field_name parameter must match one of the custom fields in the Flexito OmniAI bot. Ensure the data type matches the custom field's type.

Use the following formats for values:

  • For a Number field type, the value should be numeric, like 2 or 3.14, and not enclosed in double quotation marks.

  • For a Text field type, the value should be sent as text, like "some text".

  • For a Date field type, the value should be sent as text formatted as YYYY-MM-DD, e.g., " (tel:)".

  • For a Date Time field type, the value should be sent as text formatted in ISO8601 UTC, e.g., " (tel:)T13:25:00.000Z".

Clear a Subscriber's Field Value

This response allows you to clear a subscriber's field value. Ensure the custom field already exists in your bot.

{ "version": "v1", "content": { "messages": [ { "type": "text", "text": "simple text with button", "buttons": [ { "type": "url", "caption": "External link", "url": "" } ] } ], "actions": [ { "action": "unset_field_value", "field_name": "your field name" } ], "quick_replies": [] } }