API ReferenceCampaigns
Send or schedule campaign
Send a campaign immediately or schedule it for future delivery.
Authorization
ApiKeyAuth AuthorizationBearer <token>
API Key authentication. The project is automatically derived from the key.
/v1/track requires a public key (pk_*) — it is the one endpoint intended for client-side use, and a secret key is rejected there with 401.
Every other endpoint requires a secret key (sk_*) and rejects public keys with 401.
So the two key types are not interchangeable in either direction: pick the key that matches the endpoint you are calling.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
scheduledFor?string
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.
Format
date-timeResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.plunk.jimster.dev/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/send" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"data": {
"id": "9c4d5e1f-2a3b-4c5d-8e9f-0a1b2c3d4e5f",
"name": "March newsletter",
"status": "SCHEDULED",
"scheduledFor": "2025-02-01T09:00:00.000Z"
},
"message": "Campaign scheduled for 2025-02-01T09:00:00.000Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"statusCode": 0,
"requestId": "string",
"errors": [
{
"field": "string",
"message": "string",
"code": "string",
"received": null
}
],
"details": {},
"suggestion": "string"
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid secret API key. This endpoint requires a secret key (sk_*), not a public key.",
"statusCode": 401,
"requestId": "8f14e45f-ceea-467a-9575-1f0f38e0b1c2"
},
"timestamp": "2025-01-15T10:30:00.000Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"statusCode": 0,
"requestId": "string",
"errors": [
{
"field": "string",
"message": "string",
"code": "string",
"received": null
}
],
"details": {},
"suggestion": "string"
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"statusCode": 0,
"requestId": "string",
"errors": [
{
"field": "string",
"message": "string",
"code": "string",
"received": null
}
],
"details": {},
"suggestion": "string"
},
"timestamp": "2019-08-24T14:15:22Z"
}