Para Desenvolvedores/Dynamic Content/Mensagens - Formatos/Actions - Formats

Actions - Formats

The actions property of the server response is optional.

2026-08-12

Add tag action

Use this response to add a tag to a subscriber. A tag with the same name must exist in your channel:

texto

{
  "version": "v1",
  "content": {
    "messages": [
      {
        "type": "text",
        "text": "simple text with button",
        "buttons": [
          {
            "type": "url",
            "caption": "External link",
            "url": "https://NicoChat.com.au"
          }
        ]
      }
    ],
    "actions": [
      {
        "action": "add_tag",
        "tag_name": "your tag",
      }
    ],
    "quick_replies": []
  }
}

The tag name sent in the tag_name parameter must match one of the tags existing in the NicoChat channel

Remove tag action

Use this response to remove a tag from a subscriber. A tag with the same name must exist in your channel:

texto

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

Set subscriber's field value action

Use this response to set the subscriber's field value. A custom field with the same name must exist in your channel

texto

{
  "version": "v1",
  "content": {
    "messages": [
      {
        "type": "text",
        "text": "simple text with button",
        "buttons": [
          {
            "type": "url",
            "caption": "External link",
            "url": "https://NicoChat.com.au"
          }
        ]
      }
    ],
    "actions": [
      {
        "action": "set_field_value",
        "field_name": "your field name",
        "value": "some value"
      }
    ],
    "quick_replies": []
  }
}

The field name sent in field_name must match the name of one of the custom fields existing in the NicoChat channel. You need to control the data type recorded in the custom fields: the data type must match the type of the custom field.

Use the following value formats:

For the Number field type, the value must be numeric, such as 2 or 3.14, without double quotes;
For the Text field type, the value must be sent as text: "some text";
For the Date field type, the value must be sent as text with the date in the YYYY-MM-DD format, that is, "2018-03-25";
For the Date Time field type, the value must be sent as text with the date in ISO8601 UTC format, that is, "2018-03-25T13:25:00.000Z"

Clear subscriber's field value action

Use this response to clear (delete) the subscriber's field value. A custom field with the same name must exist in your channel

texto

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