Send a review request

Send a review request to one customer by email, text, or from a kiosk, or send a test to yourself first.

Send a review request to one customer by email, text, or from a kiosk, or send a test to yourself first.

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
POSTSend a test text to yourselfCreate a one-off audience row and queues a single SMS review request for the given campaign (dispatched after commit on the messaging queue).
POSTSend a test email to yourselfCreate a one-off audience row and queues a single Email review request for the given campaign (dispatched after commit on the messaging queue).
POSTSend a review request to a customerUnified 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.
POSTSend a review request from a kioskSubmit 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).