Skip to main content
POST
/
campaigns
curl --request POST \
  --url 'https://api.autosend.com/v1/campaigns' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Spring Sale Newsletter",
    "subject": "Don'\''t miss our Spring Sale!",
    "previewText": "Up to 50% off this weekend only",
    "from": {
      "email": "[email protected]",
      "name": "Example Team"
    },
    "replyTo": "[email protected]",
    "templateId": "60d5ec49f1b2c72d9c8b1234",
    "toLists": ["60d5ec49f1b2c72d9c8b0001"],
    "sendMode": "immediate",
    "publish": true,
    "sendNow": true,
    "trackingClick": true,
    "trackingOpen": true
  }'

{
  "success": true,
  "data": {
    "id": "69d348dd0351e0c32be90342",
    "name": "Spring Sale Newsletter",
    "subject": "Don't miss our Spring Sale!",
    "previewText": "Up to 50% off this weekend only",
    "status": "scheduled",
    "sendMode": "immediate",
    "from": {
      "email": "[email protected]",
      "name": "Example Team"
    },
    "replyTo": "[email protected]",
    "templateId": "A-280fa451a7ca5cc17513",
    "toLists": [
      {
        "id": "696e1158fbfc515799175f02",
        "name": "seg list",
        "type": "list",
        "contactCount": 3
      }
    ],
    "excludeLists": [],
    "sendNow": true,
    "sendToGlobalList": false,
    "metrics": {
      "sent": 0,
      "delivered": 0,
      "opened": 0,
      "suppressed": 0,
      "clicked": 0,
      "bounced": 0,
      "unsubscribed": 0,
      "spamReported": 0,
      "processedCount": 0,
      "totalContacts": 0,
      "failedCount": 0
    },
    "trackingClick": true,
    "trackingOpen": true,
    "source": "api",
    "createdAt": "2026-04-06T05:47:09.523Z",
    "updatedAt": "2026-04-06T05:52:38.949Z"
  },
  "message": "Campaign updated successfully"
}

curl --request POST \
  --url 'https://api.autosend.com/v1/campaigns' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Spring Sale Newsletter",
    "subject": "Don'\''t miss our Spring Sale!",
    "previewText": "Up to 50% off this weekend only",
    "from": {
      "email": "[email protected]",
      "name": "Example Team"
    },
    "replyTo": "[email protected]",
    "templateId": "60d5ec49f1b2c72d9c8b1234",
    "toLists": ["60d5ec49f1b2c72d9c8b0001"],
    "sendMode": "immediate",
    "publish": true,
    "sendNow": true,
    "trackingClick": true,
    "trackingOpen": true
  }'

{
  "success": true,
  "data": {
    "id": "69d348dd0351e0c32be90342",
    "name": "Spring Sale Newsletter",
    "subject": "Don't miss our Spring Sale!",
    "previewText": "Up to 50% off this weekend only",
    "status": "scheduled",
    "sendMode": "immediate",
    "from": {
      "email": "[email protected]",
      "name": "Example Team"
    },
    "replyTo": "[email protected]",
    "templateId": "A-280fa451a7ca5cc17513",
    "toLists": [
      {
        "id": "696e1158fbfc515799175f02",
        "name": "seg list",
        "type": "list",
        "contactCount": 3
      }
    ],
    "excludeLists": [],
    "sendNow": true,
    "sendToGlobalList": false,
    "metrics": {
      "sent": 0,
      "delivered": 0,
      "opened": 0,
      "suppressed": 0,
      "clicked": 0,
      "bounced": 0,
      "unsubscribed": 0,
      "spamReported": 0,
      "processedCount": 0,
      "totalContacts": 0,
      "failedCount": 0
    },
    "trackingClick": true,
    "trackingOpen": true,
    "source": "api",
    "createdAt": "2026-04-06T05:47:09.523Z",
    "updatedAt": "2026-04-06T05:52:38.949Z"
  },
  "message": "Campaign updated successfully"
}

​
Authorizations

​
Authorizations
string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Body

​
name
string
required
Display name of the campaign. Between 1 and 200 characters.
​
subject
string
required
Email subject line. Between 1 and 998 characters.
​
previewText
string
Preview text shown in email clients before the message is opened. Maximum 200 characters.
​
from
object
Sender identity to use for this campaign.
​
fromSenderId
string
id of a saved sender identity. Mutually usable with from.
​
replyTo
string
Reply-to email address. Must be a valid email.
​
templateId
string
ID of the email template to use for this campaign. The template can be created via the Template API. Either templateId or htmlTemplate is required.
​
htmlTemplate
string
Raw HTML content to use as the campaign email body. Either htmlTemplate or templateId is required. If both are provided, htmlTemplate takes precedence and the template referenced by templateId will be updated with the provided HTML content.
​
toLists
array
Array of list or segment IDs to send the campaign to.
​
excludeLists
array
Array of list or segment IDs to exclude from sending.
​
unsubscribeGroupId
string
ID of the unsubscribe group to associate with this campaign.
​
sendNow
boolean
If true, the campaign will be scheduled to send after 120 seconds (2 minutes) from creation.
​
scheduledAt
string
ISO 8601 date-time string at which to schedule the campaign for sending.
​
sendToGlobalList
boolean
If true, the campaign is sent to all contacts in the global list.
​
publish
boolean
If true, publishes and finalizes the campaign.
​
trackingClick
boolean
Enable or disable click tracking for this campaign.
​
trackingOpen
boolean
Enable or disable open tracking for this campaign.
​
sendMode
string
Delivery mode. One of: immediate, scheduled, gradual.
​
gradualStrategy
string
Growth strategy for gradual sending. One of: fixed, 1.25x, 1.5x, 1.75x, 2x. Required when sendMode is gradual.
​
dailyBatchSize
integer
Number of emails to send per day in gradual mode. Must be at least 1.
​
timezone
string
Timezone string (e.g. America/New_York) for scheduled or gradual sending.
​
defaultCampaign
boolean
Mark this campaign as the default campaign. Applies to create only.
​
builderType
string
Identifies the campaign builder type used to create this campaign. Applies to create only.

​
Response

Returns the newly created campaign object.
​
success
boolean
Indicates whether the request was successful.
​
message
string
A human-readable message describing the result.
​
data
object
The created campaign object.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Body

application/json
​
name
string
required

Display name of the campaign.

Required string length: 1 - 200
​
subject
string
required

Email subject line.

Required string length: 1 - 998
​
previewText
string

Preview text shown in email clients.

Maximum string length: 200
​
from
object
​
fromSenderId
string

Id of a saved sender identity.

​
replyTo
string<email>

Reply-to email address.

​
templateId
string

ID of the email template to use.

​
toLists
string[]

List/segment IDs to send the campaign to.

​
excludeLists
string[]

List/segment IDs to exclude from sending.

​
unsubscribeGroupId
string

ID of the unsubscribe group.

​
sendNow
boolean

If true, send the campaign immediately.

​
scheduledAt
string<date-time>

ISO 8601 date-time to schedule the campaign.

​
sendToGlobalList
boolean

If true, send to the entire global contact list.

​
publish
boolean

If true, publish/finalize the campaign.

​
trackingClick
boolean

Enable or disable click tracking.

​
trackingOpen
boolean

Enable or disable open tracking.

​
sendMode
enum<string>

How the campaign is delivered.

Available options:
immediate,
scheduled,
gradual
​
gradualStrategy
enum<string>

Gradual send growth strategy (used when sendMode is 'gradual').

Available options:
fixed,
1.25x,
1.5x,
1.75x,
2x
​
dailyBatchSize
integer

Number of emails to send per day in gradual mode.

Required range: x >= 1
​
timezone
string

Timezone string for scheduled sending.

​
defaultCampaign
boolean

Mark as default campaign (create only).

​
builderType
string

Campaign builder type (create only).

Response

Campaign created successfully.

​
success
boolean
Example:

true

​
data
object