SMS campaigns

Validate an SMS campaign

Check whether an SMS campaign could send now and who it would reach, without sending anything: can_send, the blockers a send would be refused for, the reachable count, the skip breakdown (no_marketing_consent, quiet_hours_deferred, and the rest in skipped_by_reason), when a quiet-hours hold would let it start, and whether a sender's use case or a missing template variable would block the send. Rate-limited per workspace. Requires the campaigns:read capability.

get/sms/campaigns/{id}/validate

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/sms/campaigns/{id}/validate
  • Auth: HTTP bearer

Response

The validation report.

object'sms_campaign_validation' required
campaign_idstring required
can_sendboolean required
totalnumber required
reachablenumber required
skippednumber required
no_marketing_consentnumber required
quiet_hours_deferrednumber required
routing'automatic' | 'fixed' | 'pool' required
use_case_mismatchboolean required
unresolved_variablesstring[] required

Changes

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