Set conversational components

Saves the conversational components — welcome message, ice-breaker prompts, and commands — that end users see when opening a chat with the app's WhatsApp number.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Body

KeyDescriptionValuesData TypeRequired/Optional
enable_welcome_messageSet true to receive request_welcome eventstrue—Required
commandsAt most 30 commands——Required
promptsAt most 4 ice-breakers, each up to 80 characters["Track my order","Talk to support"]—Required

Sample cURL — Set conversational components.

curl --request POST \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/integration/conversational/components' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "enable_welcome_message" : true,
  "commands" : [ {
    "command_name" : "track-order",
    "command_description" : "Track the status of a recent order"
  } ],
  "prompts" : [ "Track my order", "Talk to support" ]
}'

Sample success response (200)

{
  "status": "success",
  "data": {
    "success": true
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Body Params

Conversational components forwarded as-is. enable_welcome_message turns on request_welcome events; commands takes at most 30 entries (command_name up to 32 characters, command_description up to 256); prompts takes at most 4 ice-breakers of up to 80 characters each.

Welcome message, commands and ice-breakers shown when a chat opens

boolean
required

Set true to receive request_welcome events

commands
array of objects
required

At most 30 commands

commands*
prompts
array of strings
required

At most 4 ice-breakers, each up to 80 characters

prompts*
Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json