transmissions

Preview a transmission

Validates the recipient list and template and stores the result as a draft, without sending anything. Review the draft, then confirm it to dispatch.

post/api/v1/transmissions/preview

Request

  • Base URL: https://api.izap.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.izap.ai/api/v1/transmissions/preview
  • Auth: HTTP bearer

Headers

business-idstring uuid required

Request body

namestring required

Human label for the transmission.

transmission_type'whatsapp_template' | 'whatsapp_freeform'

The kind of bulk message a transmission sends.

WHATSAPP_TEMPLATE sends an approved template to a phone list. WHATSAPP_FREEFORM sends a fixed text and only reaches contacts inside Meta's 24h customer-service window. Modelled as an enum so further channels can be added without a schema change to the stored value.

max_messages_per_minuteinteger

Sending pace cap. Must be between 1 and 200 messages per minute.

template_namestring

Name of the pre-approved WhatsApp Cloud API template to send. Required for 'whatsapp_template'; not accepted for 'whatsapp_freeform', which stores a fixed default.

template_languagestring

Template language/locale code as registered with Meta, e.g. 'pt_BR'.

recipientsobject[] required

Parsed CSV rows; each row maps a string column header to its string cell value. Must include the phone column and the columns that supply the template's variables.

phone_columnstring

Name of the CSV column holding the recipient phone number (E.164 or local).

variable_columnsstring[] nullable

For positional templates ({{1}}, {{2}}, ...): the ordered CSV header names mapping to {{1}}, {{2}}, ... If omitted, the first non-phone columns are used in order. Ignored for templates with named placeholders.

message_textstring nullable

Text to send. Required for 'whatsapp_freeform', which only reaches contacts inside the WhatsApp customer-service window; others are skipped.

scheduled_atstring date-time nullable

When to send. Omit or null to send immediately on confirm. If the value has no timezone offset it is interpreted in 'timezone'.

timezonestring nullable

IANA timezone used to interpret a naive 'scheduled_at'. Defaults to the business's configured timezone (America/Sao_Paulo when none is set).

business_idstring uuid nullable

Response

Successful Response

transmission_idstring uuid required
namestring required
statusstring required
transmission_typestring required
template_namestring nullable required
template_languagestring required
uses_named_variablesboolean required
recipient_countinteger required
valid_countinteger required
invalid_countinteger required
duplicate_countinteger required
not_on_whatsapp_countinteger
outside_window_countinteger
column_mappingobject required
phone_columnstring required
estimated_duration_secondsinteger required
scheduled_atstring date-time nullable required
warningsstring[] required
business_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.