Send a review request to a customer

Send one customer a review request by email, text, or both, using a campaign's templates. An email in the body uses the Email channel and a phone the SMS channel; each channel needs an attached template. If only one channel is usable, only that one is sent (200); 400 only when none is usable. Counts against the plan's email and SMS allowances (402 when used up).

Prerequisites: a bearer token, and a campaign in your account with an enabled channel that has a template, on a location with an active plan.

Authentication: Account token. The campaign must belong to your own account; otherwise 403.

Rate limit: 60 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 4823

The campaign to send from. Must exist (otherwise 422) and belong to your own account (otherwise 403).

string
required
length ≤ 255
Defaults to Jane Smith

The customer's name, up to 255 characters.

string
length ≤ 255

The customer's email address, up to 255 characters. Sends by email. Checked with an RFC and DNS lookup, so the domain must accept mail: addresses like @example.com are rejected with 422.

string
length between 7 and 20
Defaults to +15555550100

The customer's phone number, 7–20 characters. Sends by text.

boolean
Defaults to false

true marks the send as a test: it isn't added to the campaign's recipient count and schedules no follow-up email. Default false.

keywords
object

Values for your template's placeholders, as key/value pairs, e.g. {"paragraph_1": "Thanks for visiting!"}. Each key up to 100 characters; values are strings. Empty values are skipped.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json