v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB

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