Campaigns
Launch a campaign
Queues the campaign for sending (`202`), now or at `schedule_at`. A campaign that cannot be launched is `422 launch_rejected`. Send an `Idempotency-Key` header to retry safely.
POST
Queues the campaign for sending (202), now or at schedule_at. A
campaign that cannot be launched is 422 launch_rejected. Send an
Idempotency-Key header to retry safely.
httpheader
AuthorizationBearer <token>id*integerIdempotency-Key?stringAny unique string up to 255 characters, such as a UUID. Retrying with the same key returns the first response (with Idempotent-Replayed: true) instead of acting twice.
application/json- body
schedule_at?|Overrides the campaign's schedule; null sends now.
Format
date-timeCampaign
application/json- response
data*curl -X POST 'https://app.orqo.site/api/v1/campaigns/0/launch' \ -H 'Idempotency-Key: 9f1c2a7e-4b8d-4e57-a3f0-6c1d2e3f4a5b' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "data": { "id": 0, "name": "string", "channel": "string", "status": "string", "audience_type": "string", "audience_ref": "string", "template": [ null ], "payload": [ null ], "schedule_at": "string", "timezone": "string", "stats": { "total": 0, "queued": 0, "sent": 0, "delivered": 0, "read": 0, "failed": 0 }, "created_at": "string", "updated_at": "string" }}