Skip to main content
POST
/
api
/
v1
/
campaigns
/
send-bulk
curl -X POST "https://api.usegately.com/api/v1/campaigns/send-bulk" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Project-ID: YOUR_PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP Promo",
    "subject": "Exclusive offer for you",
    "content": "<p>Here is your exclusive deal.</p>",
    "recipient_ids": [
      "customer_alice@example.com",
      "customer_bob@example.com"
    ]
  }'

{
  "success": true,
  "campaign": {
    "id": "a1b2c3d4-e5f6-4789-abcd-ef1234567890",
    "name": "VIP Promo",
    "status": "sent",
    "total_recipients": 2,
    "delivered_count": 2
  },
  "total_recipients": 2,
  "successful_sends": 2,
  "failed_sends": 0,
  "message": "Email campaign sent to 2 of 2 recipients"
}
An alternative to Send Campaign for when you already have a flat list of recipient IDs rather than contact list or segment IDs. Recipient IDs must follow the format customer_<email> or form_customer_<email>. IDs with a member_ prefix are not supported by this endpoint — use recipient_list_ids in the standard send endpoint instead.

​
Headers

​
Authorization
string
required
Bearer YOUR_API_KEY
​
X-Project-ID
string
Your project UUID. Not required if the API key already encodes the project.

​
Request Body

​
name
string
required
Campaign display name
​
subject
string
required
Email subject line
​
content
string
required
HTML email body
​
recipient_ids
string[]
required
Array of recipient IDs. Supported formats:
  • customer_alice@example.com
  • form_customer_alice@example.com
​
scheduled_at
string
ISO 8601 datetime to schedule delivery. Omit to send immediately.
​
attachments
object[]
Optional file attachments — same shape as Send Campaign

​
Response

Same shape as Send Campaign. 
curl -X POST "https://api.usegately.com/api/v1/campaigns/send-bulk" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Project-ID: YOUR_PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP Promo",
    "subject": "Exclusive offer for you",
    "content": "<p>Here is your exclusive deal.</p>",
    "recipient_ids": [
      "customer_alice@example.com",
      "customer_bob@example.com"
    ]
  }'

{
  "success": true,
  "campaign": {
    "id": "a1b2c3d4-e5f6-4789-abcd-ef1234567890",
    "name": "VIP Promo",
    "status": "sent",
    "total_recipients": 2,
    "delivered_count": 2
  },
  "total_recipients": 2,
  "successful_sends": 2,
  "failed_sends": 0,
  "message": "Email campaign sent to 2 of 2 recipients"
}