WhatsApp · WhatsApp

Set ice breakers and commands

Sets ice breakers and commands.

POSThttps://api.pozy.ai/v1/whatsapp/conversational-automation
setWhatsAppConversationalAutomation

Guides: Connect WhatsApp, Conversation starters

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

  • accountIdstringrequired
  • enable_welcome_messageboolean
  • promptsarray of string

    Up to 3 items. Each item: 1 to 80 characters.

  • commandsarray of object

    Up to 30 items.

    • command_namestringrequired

      1 to 30 characters. Matches ^[a-zA-Z0-9_]+$.

    • command_descriptionstringrequired

      1 to 256 characters.

Example

curl -X POST "https://api.pozy.ai/v1/whatsapp/conversational-automation" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "enable_welcome_message": true,
  "prompts": [
    "string"
  ],
  "commands": [
    {
      "command_name": "Acme",
      "command_description": "string"
    }
  ]
}'

Response

200 on success

  • successboolean
200 response
{
  "success": true
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in WhatsApp