Schedule Campaign

Schedule a campaign to be sent automatically at a future time. The recipient list is built immediately and total_recipients is stored on the campaign.

POST /v1/campaigns/{id}/schedule

Authentication

Requires a valid API key with campaigns:write scope.

Path Parameters

Parameter	Type	Description
id	integer	The campaign ID

Request Body

Field	Type	Required	Description
scheduled_at	string	Yes	Send time (ISO 8601). Must be in the future; stored in UTC

Prerequisites

• The campaign must be in draft or scheduled status
• email_subject and email_body must be set

Request Example

curl -X POST "https://app.equipdash.com/api/v1/campaigns/42/schedule" \
  -H "Authorization: Bearer eqd_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "scheduled_at": "2026-07-25T08:00:00+00:00"
  }'

Response (200 OK)

Returns the campaign with status scheduled.

{
  "data": {
    "id": 42,
    "name": "Summer Kayak Promo",
    "description": "Promote summer kayak rentals",
    "kind": "one_off",
    "channel": "email",
    "status": "scheduled",
    "audience_type": "filter",
    "audience_filter": {
      "v": 2,
      "preset": "recent"
    },
    "email_subject": "Summer is here, {customer_name}!",
    "email_body": "<p>Hi {customer_name}, book your kayak now.</p>",
    "template_key": "promo_blast",
    "cta_text": "Book now",
    "cta_url": "https://example.com/book",
    "scheduled_at": "2026-07-25T08:00:00+00:00",
    "sent_at": null,
    "total_recipients": 250,
    "total_sent": 0,
    "created_at": "2026-07-01T09:00:00+00:00",
    "updated_at": "2026-07-20T10:00:00+00:00"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-07-20T10:00:00+00:00"
  }
}

Error Responses

Status	Code	Description
403	insufficient_scope	API key lacks campaigns:write scope
404	resource_not_found	Campaign not found
422	validation_error	scheduled_at is missing or not in the future
422	validation_error	email_subject or email_body is missing
422	invalid_state	Campaign has already been sent