Create a campaign
Created as a draft. Nothing goes out until you start it.
Try it — POST /campaigns
Kept for this tab only — it disappears when you close it, and it is never sent anywhere except as the Authorization header on the call below.
Authorization
bearerAuth campaigns:writeAuthorization: Bearer sk_live_.... Keys in the query string or the
request body are refused — a URL is logged by every proxy it passes,
and that is how customer keys leak.
A key carries scopes. A call outside them answers 403 with
insufficient_scope and names the scope it wanted.
In: header
Scope: campaigns:write
Header Parameters
Any unique string, one per logical request. Retrying with the same key
returns the first answer instead of doing the work twice, and answers
with Idempotent-Replay: true.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
name, channels and group_id are required on POST and optional on
PATCH.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST https://app.sendkuy.com/api/v1/campaigns \ -H "Authorization: Bearer sk_live_YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Promo Ramadan", "channels": [ "whatsapp" ], "group_id": "grp_9cBe3A1H-SLhW5fONWZ32wb-IIio5Ts3"}'{ "data": { "object": "campaign", "id": "cmp_9cBe3A1H-SLhW5fONWZ32wb-IIio5Ts3", "name": "string", "description": "string", "status": "draft", "type": "instant", "channels": [ "email" ], "group_id": "string", "total_contacts": 0, "processed_contacts": 0, "scheduled_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "stats": { "total": 0, "pending": 0, "queued": 0, "processing": 0, "sent": 0, "delivered": 0, "failed": 0, "opened": 0, "clicked": 0, "replied": 0, "bounced": 0, "unsubscribed": 0, "by_channel": { "property1": { "total": 0, "sent": 0, "delivered": 0, "failed": 0, "opened": 0, "clicked": 0 }, "property2": { "total": 0, "sent": 0, "delivered": 0, "failed": 0, "opened": 0, "clicked": 0 } } } }}