Skip to navigation
API ReferenceBroadcasts

Validate a recipient list (dry run)

View as Markdown

Runs the same recipient validator the send endpoints use and returns per-row diagnostics - without reserving credit, inserting messages, or enqueueing anything. Use it to pre-flight a large recipient list before committing to a broadcast.

Required scope: none beyond a valid API key. Rate limit: 10 requests / 15 min / client

The invalid[].code values are the same ones the send endpoints return in their Recipient validation failed response.

Authentication

AuthorizationBearer

Bearer API keys are issued from the in-app /api-management page. Each key has a permission scope (send_sms, send_whatsapp, send_email) and an optional IP whitelist.

The IP whitelist, when set, is matched by exact string equality against the resolved caller IP - CIDR ranges are not supported. An empty whitelist allows any source address.

Request

This endpoint expects an object.
channelenumRequired
Allowed values:
recipientslist of stringsOptional
recipientVariableslist of objectsOptional

Response

Validation result
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
413
Content Too Large Error
429
Too Many Requests Error
500
Internal Server Error