Test sends

SMS / email / generic / kiosk test sends — preview a review-request before launching the campaign.

SMS / email / generic / kiosk test sends — preview a review-request before launching the campaign.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
POSTTest SMS review requestCreate a one-off audience row and queues a single SMS review request for the given campaign (dispatched after commit on the messaging queue).
POSTTest email review requestCreate a one-off audience row and queues a single Email review request for the given campaign (dispatched after commit on the messaging queue).
POSTSend review request (email and/or SMS)Unified send-review-request: creates audience row(s) and queues an Email and/or SMS review request for a campaign, branching on whether email and/or phone is supplied.
POSTKiosk review requestSubmit an in-store kiosk review request: looks up a campaign by unique_code, creates a kiosk audience row, and queues an email and/or SMS review-request send (one or both, depending on whether email/phone are supplied and the matching channel is enabled and within service limits).