Sign in
Campaigns

Send or schedule campaign

Send a campaign immediately or schedule it for future delivery.

post/campaigns/{id}/send

Path parameters

idstring uuid required

Request body

scheduledForstring date-time nullable

Timestamp for when to send the campaign. Omit or set to null for immediate send. Any value new Date() can parse is accepted; an unparseable one returns 400.

Response

Campaign scheduled or sending

successboolean
messagestring

Human-readable confirmation, e.g. Campaign is being sent.

Changes