Skip to main content
POST
/
v1
/
campaigns
cURL
curl --request POST \
  --url https://app.usesend.com/api/v1/campaigns \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "from": "<string>",
  "subject": "<string>",
  "previewText": "<string>",
  "contactBookId": "<string>",
  "content": "<string>",
  "html": "<string>",
  "replyTo": "<string>",
  "cc": "<string>",
  "bcc": "<string>",
  "sendNow": true,
  "scheduledAt": "<string>",
  "batchSize": 50000
}'
{
  "id": "<string>",
  "name": "<string>",
  "from": "<string>",
  "subject": "<string>",
  "previewText": "<string>",
  "contactBookId": "<string>",
  "html": "<string>",
  "content": "<string>",
  "status": "<string>",
  "scheduledAt": "2023-11-07T05:31:56Z",
  "batchSize": 123,
  "batchWindowMinutes": 123,
  "total": 123,
  "sent": 123,
  "delivered": 123,
  "opened": 123,
  "clicked": 123,
  "unsubscribed": 123,
  "bounced": 123,
  "hardBounced": 123,
  "complained": 123,
  "replyTo": [
    "<string>"
  ],
  "cc": [
    "<string>"
  ],
  "bcc": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
​
name
string
required
Minimum length: 1
​
from
string
required
Minimum length: 1
​
subject
string
required
Minimum length: 1
​
contactBookId
string
required
Minimum length: 1
​
previewText
string
​
content
string
Minimum length: 1
​
html
string
Minimum length: 1
​
replyTo
Minimum length: 1
​
cc
Minimum length: 1
​
bcc
Minimum length: 1
​
sendNow
boolean
​
scheduledAt
string

Timestamp in ISO 8601 format or natural language (e.g., 'tomorrow 9am', 'next monday 10:30')

​
batchSize
integer
Required range: 1 <= x <= 100000

Response

200 - application/json

Create a campaign

​
id
string
required
​
name
string
required
​
from
string
required
​
subject
string
required
​
previewText
string | null
required
​
contactBookId
string | null
required
​
html
string | null
required
​
content
string | null
required
​
status
string
required
​
scheduledAt
string<date-time> | null
required
​
batchSize
integer
required
​
batchWindowMinutes
integer
required
​
total
integer
required
​
sent
integer
required
​
delivered
integer
required
​
opened
integer
required
​
clicked
integer
required
​
unsubscribed
integer
required
​
bounced
integer
required
​
hardBounced
integer
required
​
complained
integer
required
​
replyTo
string[]
required
​
cc
string[]
required
​
bcc
string[]
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
⌘I