Test email review request

Create a one-off audience row and queues a single Email review request for the given campaign (dispatched after commit on the messaging queue).

Auth: Account — authentication, ACCOUNT-scope group. If not owned by the caller it returns 403 ("You are not authorized to test this campaign"). The campaign must have an enabled Email channel with a valid template, and the store must have an active plan, else 400.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
campaign_idintegeryesMust be an existing campaign inside your own account tree.
customer_namestringyesmax 255; trimmed before save.
emailstringyesemail:rfc,dns, max 255.
is_testbooleannonullable; tagged onto audience + email request rows. Defaults false.
keywordsobjectnonullable map; each key max 100 chars, values are strings. Empty/null values skipped; stored as recipient template placeholders.

Response{ data. } envelope. data is { status: "success", message: "Email review request sent successfully" }. (Response also carries plan feature headers for review_solicitation_email.) Returns 400 ("Failed to send Email review request") if no request was created.

  • data.status (string) — "success".
  • data.message (string).

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
string
boolean
keywords
object
Response

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