Test SMS review request

Overview

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

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

POST /api/v1/campaign/test-sms-review-request

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• 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.

• The store must have an active plan, else 400.

Rate limit

• No rate limit.

Request body

• Body:

{
  "campaign_id": 1,
  "customer_name": "John Doe",
  "phone": "+15551234567",
  "is_test": true,
  "keywords": {
    "paragraph_1": "Thanks for visiting our store today!"
  }
}

Response

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

200 OK · 200

{
  "data": {
    "status": "success",
    "message": "SMS review request sent successfully"
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/test-sms-review-request" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"campaign_id": 1, "customer_name": "John Doe", "phone": "+15551234567", "is_test": true, "keywords": {"paragraph_1": "Thanks for visiting our store today!"}}'