Skip to main content
POST
/
api
/
v1
/
transmissions
/
preview
Preview a transmission from a CSV recipient list
curl --request POST \
  --url https://api.izap.ai/api/v1/transmissions/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'business-id: <business-id>' \
  --data '
{
  "name": "<string>",
  "template_name": "<string>",
  "template_language": "<string>",
  "recipients": [
    {}
  ],
  "phone_column": "<string>",
  "transmission_type": "whatsapp_template",
  "max_messages_per_minute": 60,
  "variable_columns": {},
  "scheduled_at": "2023-11-07T05:31:56Z",
  "timezone": "<string>"
}
'
{
  "transmission_id": "tr1a2b3c-1234-4a5b-9c8d-abcdef123456",
  "name": "July promo",
  "status": "draft",
  "transmission_type": "whatsapp_template",
  "template_name": "order_confirmation",
  "template_language": "pt_BR",
  "recipient_count": 100,
  "valid_count": 98,
  "invalid_count": 2,
  "duplicate_count": 0,
  "estimated_duration_seconds": 60
}

Authorizations

​
Authorization
string
header
required

JWT access token obtained from POST /api/v1/auth/jwt/login, the OAuth token endpoint, or a business-scoped API token. Some Business/Chat/Template/Scheduling endpoints alternatively accept HTTP Basic credentials scoped to the business slug.

Headers

​
business-id
string<uuid>
required

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
template_name
string
required
​
template_language
string
required
​
recipients
object[]
required

Parsed CSV rows (column header -> value).

​
phone_column
string
required
​
transmission_type
enum<string>
default:whatsapp_template
Available options:
whatsapp_template
​
max_messages_per_minute
integer
default:60
Required range: 1 <= x <= 200
​
variable_columns
object | null
​
scheduled_at
string<date-time> | null
​
timezone
string | null

Response

Draft transmission preview.

​
transmission_id
string<uuid>
​
name
string
​
status
string
Example:

"draft"

​
transmission_type
string
​
template_name
string
​
template_language
string
​
recipient_count
integer
​
valid_count
integer
​
invalid_count
integer
​
duplicate_count
integer
​
estimated_duration_seconds
integer
​
scheduled_at
string<date-time> | null
​
warnings
string[]