Rapidbott Help Docs
HomeInstagramFacebookLinkedInTwitterWebsite
  • Welcome !
  • start here
    • Getting Support
    • FAQ's
    • WhatsApp Common Questions(FAQ)
    • Pricing Plans
  • getting started guide
    • Introduction
    • Set your goals
    • Building your Chatbot with Rapidbott.
    • Maintain success
  • Rapidbott guide for beginners
    • Introduction
    • What is a Chatbot
    • Channels
    • Benefits & importance
    • Use cases
  • platform
    • Introduction
      • How to start free trial
      • Forgot Password
      • Getting Started Checklist
      • Platform Overview
      • Workspaces & Members
      • Platform default limits
      • Integrations
        • Stripe
        • PayPal
        • Cloudinary
        • Shopify
        • Facebook Business
        • Calendly
        • Slack
        • Google Sheets
        • Data Store
        • Twilio
        • Signalwire
        • Email (SMTP / Gmail)
        • MailChimp
        • VideoSdk
      • Ecommerce
        • Setup Ecommerce
        • Use Ecommerce in the Flow
        • WooCommerce
    • Connect to Channels
    • Agents Group Chat
    • Website Chat
    • My Contents
      • Email Templates
      • Rapidbott Bot Templates
    • WhatsApp Channel
      • Connect with WhatsApp Cloud API
        • Using a phone number already in use with WhatsApp App
        • Step-by-Step Coexistence Onboarding
      • WhatsApp Cloud API Old
      • Connect with Com.bot
      • Connect with Twilio
      • Connect with 360Dialog
      • Connect with 360 Dialog Sandbox
      • How to get your business verified?
      • WABA Policy Enforcement
  • flow builder
    • Flow builder overview
    • Basic Actions
      • Add & Remove Tag
      • Subscribe and Unsubscribe to Bot
      • Set Email Opt-in & Opt-Out
      • Set SMS Opt-in & Opt-Out
      • Steps
      • Question step
      • Variable Operation
      • JSON Operation
      • Send Notification
      • Condition Step
      • Split Step
      • Go To Step
      • Mark Conversation Open/Pending/Spam/Done/Invalid
      • Add note to teammates
      • Delete Bot User
      • Assign to agent/agent group
      • Resume Bot Automation
      • Talk to human/Pause automation
    • Advanced Actions
      • External Request
    • Field variable
    • Sub Flows
      • Sub Flow
      • Workflow
      • Function Flow
  • Artificial Intelligencs
    • OpenAI | ChatGPT
    • DeepSeek AI
    • Google Gemini
    • Claude AI
    • X.AI Integration
    • Coze
    • Dialogflow
  • Mini Apps
    • What is Mini-App?
    • Create Mini-Apps (1.0)
    • Use Mini-Apps
    • Publish Mini-App
    • Mini-App 2.0
      • Overview (mini-app 2.0)
      • Flow Builder (mini-app 2.0)
      • Flows
      • App Fields
      • Auth
      • Action Subflow
      • Triggers
      • One Time Urls
      • Sources
      • Settings
      • Razorpay Demo (Indian Payment Gateway)
  • Users
    • Live Chat
    • Bot Contacts/Users
  • bot automation
    • Keywords
    • Sequences
    • Triggers
    • Comment Keywords
  • contents
    • Custom Fields
    • Tags
    • One Time Notification (Facebook)
    • Personas
    • Menus
    • Customer Feedback (Facebook)
  • tools
    • Error Logs
    • Testers
    • Admins
    • Multi Languages
    • Inbound Webooks
  • Broadcasting
    • Broadcasts
  • developers
    • Rapidbott API
    • Dynamic Content
      • Messages format
      • Buttons
      • Actions format
      • Quick replies
      • Goto
      • Variables
  • Beta Launch
    • Day One
  • Common Error Log Database
    • Common Errors
      • Global Error
      • Facebook Channel Common Errors
      • WhatsApp Channel Common Errors
      • Instagram Channel Common Errors
      • Webchat/Omnichannel Errors
      • SMS Channel Common Errors
      • Voice Channel Common Errors
      • Telegram Channel Common Errors
  • Bot Add-Ons
    • Bot Add-Ons
  • community
    • Website
    • Facebook
    • Instagram
    • Twitter
    • LinkedIn
Powered by GitBook
On this page
  • Action add tag
  • Action remove tag
  • Action set subscriber’s field value
  • Action unset subscriber’s field value

Was this helpful?

  1. developers
  2. Dynamic Content

Actions format

actions property of server response is optional.

Action add tag

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

Action remove tag

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": []
  }
}

Action set subscriber’s field value

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"

Action unset subscriber’s field value

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": []
  }
}
PreviousButtonsNextQuick replies

Last updated 1 year ago

Was this helpful?