post
https://production-api.shoutaboutus.com/api/v1/campaign/test-sms-review-request
Create a one-off audience row and queues a single SMS 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 SMS channel with a valid template, and the store must have an active plan, else 400.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
campaign_id | integer | yes | Must be an existing campaign inside your own account tree. |
customer_name | string | yes | max 255; trimmed before save. |
phone | string | yes | min 7, max 20; include country code. |
is_test | boolean | no | nullable; tagged onto audience + sms request rows. Defaults false. |
keywords | object | no | nullable 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: "SMS review request sent successfully" }. (Response also carries plan feature headers for review_solicitation_sms.) Returns 400 ("Failed to send SMS 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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…