| Parameter | Type | Required | Description |
|---|---|---|---|
phoneId | number/string | Yes | Your WhatsApp Business API phone ID (numeric) |
phoneId must be a numeric ID from your
WhatsApp Business API configuration. This is different from WhatsApp Web (QR)
which uses string identifiers.| Field | Type | Required | Description |
|---|---|---|---|
to_phone_number | string | Yes | Contact’s WhatsApp phone number (with country code) |
stage_id | string | Yes | UUID of the pipeline stage where the ticket should start |
contact_name | string | No | Full name of the contact |
email | string | No | Contact’s email address (must be valid email format) |
contact_metadata | object | No | Custom key-value pairs for contact-level data |
ticket_metadata | object | No | Custom key-value pairs for ticket-level data |
integration_data | object | No | Integration-specific data (e.g., external system IDs) |
message | object | No | Optional initial message to send when creating the ticket |
| Field | Type | Required | Description |
|---|---|---|---|
content | string | No | Text content of the message to send |
templateId | string | No | ID of a template to use (if using smart templates) |
ai_generated | boolean | Yes | Whether the message is AI-generated (true) or manual |
| Field | Type | Description |
|---|---|---|
aiContactId | string (UUID) | Unique identifier of the created or existing contact |
status | string | Status of the operation (always “ok”) |
123456789 (numeric phone ID from WhatsApp Business API)"+56912345678" (this is the customer’s phone number, not your phone ID)"my-phone-id" (string identifier - use web-whatsapp endpoint instead)to_phone_number field accepts phone numbers in various formats:
"+56912345678" (recommended)"56912345678"56912345678| Status Code | Description |
|---|---|
| 400 | Bad Request - Invalid phone number or stage ID |
| 401 | Unauthorized - Invalid or missing API key |
| 404 | Not Found - Phone ID doesn’t exist or is not numeric |
| 500 | Internal Server Error - Something went wrong |
phoneId parameter must be a number, not a string identifierPOST /api/public/ticket/open/web-whatsapp/{phoneId} insteadstage_id exists in your pipelines - use GET /api/public/pipeline to get valid stage IDscontact_metadata and ticket_metadata accept any key-value pairs as objectscontent or use a templateId with variablesmessage.content is provided without templateId: Sends a plain text message via WhatsApp Business APImessage.templateId is provided: Sends a WhatsApp approved template with variablesaiContactId to track this contact for future operations| Feature | WhatsApp Business API (This) | WhatsApp Web (QR) |
|---|---|---|
| Endpoint | /api/public/ticket/open/whatsapp/ | /api/public/ticket/open/web-whatsapp/ |
| Phone ID Format | Numeric (e.g., 123456789) | String (e.g., "phone_abc123") |
| Connection Type | Official API from Meta | QR code connection |
| Message Types | Templates and plain text | Plain text only |
| Reliability | Higher (official API) | Depends on QR connection |
| Scalability | Better for high volume | Limited by QR session |
API key needed to authorize the request
Ticket created successfully