Skip to main content
POST
Preview a transmission from a CSV recipient list

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[]