Create / update campaign (wizard step)

Overview

Create or advance a review-solicitation campaign through the 4-step setup wizard, branching on the step field. Step 1 updateOrCreates a draft campaign (owner = authenticated user, company_id = user's company). Step 2 toggles the SMS/Email channels (only when the store's active plan enables the matching solicitation feature). Step 3 stores the scheduling config; step 4 finalizes the campaign to scheduled and computes next_execution_time. Side effects: writes to rs_campaigns and campaign_channels (soft-delete/restore on channel toggles).

Prerequisites

• A bearer token in the Authorization header.

Base URL

Endpoint

POST /api/v1/campaign/create

Authentication

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

• Account — authentication, ACCOUNT-scope group. store_id must sit inside your own account tree (must belong to the caller's company); the campaign records user_id and the caller's person.company_id.

Rate limit

• No rate limit.

Request body

{
  "store_id": 123,
  "step": 1,
  "campaign_id": null,
  "name": "Summer Review Campaign"
}

How it works

• 200 on every successful step. The response envelope carries status, message, campaign_id, and the full re-loaded campaign under data.
• 400 (badRequestResponse) for invalid state transitions: editing a non-draft campaign on step 2. Missing solicitation feature on the plan; audience/automation not set up on steps 3–4; file still processing on step 4.
• 404 when you supply campaign_id on steps ≥2 but does not resolve.
• 422 on validation failure.

Response

200 OK · 200

{
  "data": {
    "status": "success",
    "message": "Campaign has been saved successfully",
    "campaign_id": 1,
    "data": {
      "id": 1,
      "name": "Summer Review Campaign",
      "description": null,
      "status": "draft",
      "current_step": 1,
      "store_id": 123,
      "scheduled_at": null,
      "started_at": null,
      "completed_at": null,
      "total_audience": 0,
      "request_per_day": 0,
      "request_frequency": 0,
      "request_delay": 0,
      "request_after_time": "14:00:00",
      "next_execution_time": null,
      "request_file_status": "pending",
      "request_file_name": null,
      "send_immediately": false,
      "request_file_path": null,
      "type": null,
      "channels": [],
      "email_requests": [],
      "sms_requests": [],
      "file_header": null
    }
  }
}

422 Validation · 422

{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/create" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"store_id": 123, "step": 1, "campaign_id": null, "name": "Summer Review Campaign"}'