post
https://production-api.shoutaboutus.com/api/v1/campaign/test-review-request
Create a one-off audience row and queues an Email and/or SMS review request for a campaign (dispatched after DB commit onto the messaging queue). Branches on whether email and/or phone is supplied. Serves both production and test sends via the is_test flag. A non-test send increments the campaign's total_audience and schedules a follow-up email when the email channel has a follow-up template.
Deprecated path. POST /campaign/test-review-request is a backward-compatible alias that points at the same sendReviewRequest handler as the canonical POST /campaign/review-request (documented as Send review request (email and/or SMS)). Migrate callers to review-request.
Auth
- Account — authentication, ACCOUNT-scope group. If not owned by the caller it returns 403 ("You are not authorized to send a review request for this campaign"). Store must have an active plan (400 otherwise).
Rate limit
- No rate limit.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
campaign_id | integer | Required | Must be an existing campaign inside your own account tree. |
customer_name | string | Required | max 255; trimmed. |
email | string | Conditional | required_without:phone; nullable, email:rfc,dns, max 255. Drives the Email send. |
phone | string | Conditional | required_without:email; nullable, min 7, max 20. Drives the SMS send. |
is_test | boolean | Optional | nullable. When true, tags every downstream row as test and skips follow-ups; does not increment total_audience. Defaults false. |
keywords | object | Optional | nullable map; each key max 100 chars. Empty/null values skipped. |
keywords.* | string | Optional | nullable value per keyword. |
At least one of email or phone is required.
Behaviour
- 200
{ status: "success", message }where message reflects which channel(s) were queued ("Email and SMS.", "Email.", or "SMS review request sent successfully"). - 403 if the caller does not own the campaign.
- 400 for: no active plan. A requested channel is missing/disabled or lacks a valid template. Missing review-site URLs in the landing page / email template (returns the per-site error list); or "Failed to send review request" if nothing was created.
- 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…