POST

Try POST /v1/convai/whatsapp/outbound-message — ElevenLabs API

ElevenLabs playground

Send An Outbound Message Via Whatsapp

Credentials

ElevenLabs API key · sent as xi-api-key

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.elevenlabs.io; the proxy stores and logs nothing about them.

Body application/json

{
  "whatsapp_phone_number_id": "whatsapp-phone-number-id",
  "whatsapp_user_id": "whatsapp-user-id",
  "template_name": "example-template-name",
  "template_language_code": "example-template-language-code",
  "template_params": [
    {
      "type": "header",
      "parameters": [
        {
          "parameter_name": "example-parameter-name",
          "type": "text",
          "text": "example-text"
        }
      ]
    }
  ],
  "agent_id": "agent-id",
  "conversation_initiation_client_data": {
    "conversation_config_override": {
      "agent": {
        "first_message": "Hello, how can I help you today?",
        "language": "en",
        "prompt": {
          "knowledge_base": [],
          "llm": "gemini-2.0-flash-001",
          "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
          "tool_ids": []
        }
      },
      "asr": {
        "keywords": [
          "hello",
          "world"
        ]
      },
      "conversation": {
        "max_duration_seconds": 600
      },
      "tts": {
        "model_id": "eleven_turbo_v2",
        "pronunciation_dictionary_locators": [],
        "similarity_boost": 0.8,
        "speed": 1,
        "stability": 0.5,
        "voice_id": "cjVigY5qzO86Huf0OWal"
      },
      "turn": {
        "soft_timeout_config": {
          "message": "Hhmmmm...yeah."
        }
      }
    },
    "custom_llm_extra_body": {},
    "user_id": "example-user-id",
    "source_info": {
      "source": "unknown",
      "version": "example-version"
    },
    "branch_id": "example-branch-id",
    "environment": "example-environment",
    "starting_workflow_node_id": "example-starting-workflow-node-id",
    "procedure_ids": [
      "example-procedure-ids"
    ],
    "dynamic_variables": {}
  }
}

7 body fields

whatsapp_phone_number_id · required · string — Request body field whatsapp_phone_number_id.
whatsapp_user_id · required · string — Request body field whatsapp_user_id.
template_name · required · string — Request body field template_name.
template_language_code · required · string — Request body field template_language_code.
template_params · required · object[] — Request body field template_params.
agent_id · required · string — Request body field agent_id.
conversation_initiation_client_data · optional · object — Request body field conversation_initiation_client_data.