Sign in
Campaigns

Schedule Campaign

Schedule a campaign for future delivery. scheduledAt must be in the future. Requires API key with campaign:write.

post/v1/campaigns/{id}/schedule

Path parameters

idstring required

Campaign ID

Headers

Idempotency-Keystring

Optional key (max 100 chars) for safe retries. Same key + same body within 24h replays the original response (same status and body); same key + a different body returns 409 IDEMPOTENCY_CONFLICT. Scoped per API key.

Request body

scheduledAtstring date-time required

ISO 8601 datetime for sending

scheduledTimezonestring

IANA timezone (e.g. America/New_York). Defaults to UTC.

Response

Campaign scheduled

successboolean required
errorstring nullable

Changes

Changed in 2 of the 7 revisions of this API.11

  • 6b3357db6cf61See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/recipientIds to the response with the 200 status

      response-optional-property-added

  • 3f3dba69574b1See the full diff
    • ●

      added the new pending_review enum value to the allOf[subschema #2]/data/status response property for the response status 200

      response-property-enum-value-added