Send a review request from a kiosk

Send a review request entered on an in-store device or tablet, for a campaign identified by its unique_code. An email 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; when none is usable the call returns 400 with the causes in errors[].

Prerequisites: a bearer token and the campaign's unique_code; the campaign needs an enabled channel with a template, on a location with an active plan.

Authentication: Account token. Only an Account token is accepted (otherwise 403); the campaign must belong to your own account (otherwise 404).

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
string
required
Defaults to 9445a2

The campaign's unique code. Must match a campaign in your own account; otherwise 404.

string
required
length ≤ 255
Defaults to Jane Smith

The customer's name, up to 255 characters, without < or >.

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.

string
length ≤ 255
Defaults to Front Desk Kiosk

Who entered the request, e.g. the kiosk or staff member, up to 255 characters, without < or >.

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