Create a campaign

POST

campaigns

Create a campaign

curl --request POST \
  --url https://api.seamless.ai/api/client/v2/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Summer Outreach",
  "emailAccountIds": [
    "<string>"
  ],
  "steps": [
    {
      "name": "<string>",
      "dueDay": 2,
      "description": "<string>",
      "templateId": "<string>"
    }
  ],
  "dailyTaskLimits": [
    {
      "dueDay": 2,
      "dailyTaskLimit": 2
    }
  ],
  "isDailyTaskLimitEnabled": true,
  "dailySendLimits": [
    {
      "emailAccountId": "<string>",
      "dailySendLimit": 1
    }
  ],
  "contactIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.seamless.ai/api/client/v2/campaigns"

payload = {
    "name": "Summer Outreach",
    "emailAccountIds": ["<string>"],
    "steps": [
        {
            "name": "<string>",
            "dueDay": 2,
            "description": "<string>",
            "templateId": "<string>"
        }
    ],
    "dailyTaskLimits": [
        {
            "dueDay": 2,
            "dailyTaskLimit": 2
        }
    ],
    "isDailyTaskLimitEnabled": True,
    "dailySendLimits": [
        {
            "emailAccountId": "<string>",
            "dailySendLimit": 1
        }
    ],
    "contactIds": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Summer Outreach',
    emailAccountIds: ['<string>'],
    steps: [{name: '<string>', dueDay: 2, description: '<string>', templateId: '<string>'}],
    dailyTaskLimits: [{dueDay: 2, dailyTaskLimit: 2}],
    isDailyTaskLimitEnabled: true,
    dailySendLimits: [{emailAccountId: '<string>', dailySendLimit: 1}],
    contactIds: ['<string>']
  })
};

fetch('https://api.seamless.ai/api/client/v2/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.seamless.ai/api/client/v2/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Summer Outreach',
    'emailAccountIds' => [
        '<string>'
    ],
    'steps' => [
        [
                'name' => '<string>',
                'dueDay' => 2,
                'description' => '<string>',
                'templateId' => '<string>'
        ]
    ],
    'dailyTaskLimits' => [
        [
                'dueDay' => 2,
                'dailyTaskLimit' => 2
        ]
    ],
    'isDailyTaskLimitEnabled' => true,
    'dailySendLimits' => [
        [
                'emailAccountId' => '<string>',
                'dailySendLimit' => 1
        ]
    ],
    'contactIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.seamless.ai/api/client/v2/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"Summer Outreach\",\n  \"emailAccountIds\": [\n    \"<string>\"\n  ],\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"dueDay\": 2,\n      \"description\": \"<string>\",\n      \"templateId\": \"<string>\"\n    }\n  ],\n  \"dailyTaskLimits\": [\n    {\n      \"dueDay\": 2,\n      \"dailyTaskLimit\": 2\n    }\n  ],\n  \"isDailyTaskLimitEnabled\": true,\n  \"dailySendLimits\": [\n    {\n      \"emailAccountId\": \"<string>\",\n      \"dailySendLimit\": 1\n    }\n  ],\n  \"contactIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.seamless.ai/api/client/v2/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Summer Outreach\",\n  \"emailAccountIds\": [\n    \"<string>\"\n  ],\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"dueDay\": 2,\n      \"description\": \"<string>\",\n      \"templateId\": \"<string>\"\n    }\n  ],\n  \"dailyTaskLimits\": [\n    {\n      \"dueDay\": 2,\n      \"dailyTaskLimit\": 2\n    }\n  ],\n  \"isDailyTaskLimitEnabled\": true,\n  \"dailySendLimits\": [\n    {\n      \"emailAccountId\": \"<string>\",\n      \"dailySendLimit\": 1\n    }\n  ],\n  \"contactIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.seamless.ai/api/client/v2/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Summer Outreach\",\n  \"emailAccountIds\": [\n    \"<string>\"\n  ],\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"dueDay\": 2,\n      \"description\": \"<string>\",\n      \"templateId\": \"<string>\"\n    }\n  ],\n  \"dailyTaskLimits\": [\n    {\n      \"dueDay\": 2,\n      \"dailyTaskLimit\": 2\n    }\n  ],\n  \"isDailyTaskLimitEnabled\": true,\n  \"dailySendLimits\": [\n    {\n      \"emailAccountId\": \"<string>\",\n      \"dailySendLimit\": 1\n    }\n  ],\n  \"contactIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "campaign": {
      "campaignId": "1234",
      "name": "<string>",
      "identifier": "<string>",
      "status": "draft",
      "isPublic": true,
      "numContacts": 123,
      "numSteps": 123,
      "numDays": 123,
      "userIdOwner": "<string>",
      "ownerName": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "pausedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "emailAccountIds": [
        "<string>"
      ],
      "dailySendCapacity": 123,
      "dailySendLimits": [
        {
          "emailAccountId": 123,
          "email": "<string>",
          "dailySendLimit": 123,
          "sentToday": 123
        }
      ],
      "dailyTaskLimits": [
        {
          "dueDay": 123,
          "dailyTaskLimit": 123
        }
      ],
      "isDailyTaskLimitEnabled": true
    },
    "steps": [
      {
        "campaignStepId": "5678",
        "campaignId": "<string>",
        "type": "<string>",
        "name": "<string>",
        "description": "<string>",
        "status": "DRAFT",
        "stepNumber": 0,
        "dueDay": 123,
        "templateId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "contactsAdded": 123
  }
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Body

application/json

name

string

required

Campaign name.

Example:

"Summer Outreach"

emailAccountIds

(string | integer)[]

Sending inboxes to link, as emailAccountId values from GET /email-accounts. Unknown IDs return 400.

steps

object[]

Steps to create, in order.

Show child attributes

dailyTaskLimits

object[] | null

Task limit per cadence day. Each dueDay must match a step in steps; a dailyTaskLimit of null keeps that day's default. Requires the campaign send limits feature (campaignSendLimits on GET /features); otherwise 403 with code noFeatureAccess.

Show child attributes

isDailyTaskLimitEnabled

boolean | null

Whether dailyTaskLimits are enforced. Omitted or null means false. When false, no step has a daily task cap and email steps still follow their inbox send limits. Requires the campaign send limits feature; otherwise 403 with code noFeatureAccess.

dailySendLimits

object[] | null

This campaign's daily send limit on each inbox in emailAccountIds. An account not in emailAccountIds returns 400. Requires the campaign send limits feature; otherwise 403 with code noFeatureAccess.

Show child attributes

contactIds

(string | integer)[]

Saved contact IDs to enroll. IDs that are not saved contacts in the organization are skipped, as are contacts below the organization's email quality threshold when that setting blocks low-quality emails.

Maximum array length: 500

Response

The created campaign, its steps, and the number of contacts enrolled.

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Create a campaign

curl --request POST \
  --url https://api.seamless.ai/api/client/v2/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Summer Outreach",
  "emailAccountIds": [
    "<string>"
  ],
  "steps": [
    {
      "name": "<string>",
      "dueDay": 2,
      "description": "<string>",
      "templateId": "<string>"
    }
  ],
  "dailyTaskLimits": [
    {
      "dueDay": 2,
      "dailyTaskLimit": 2
    }
  ],
  "isDailyTaskLimitEnabled": true,
  "dailySendLimits": [
    {
      "emailAccountId": "<string>",
      "dailySendLimit": 1
    }
  ],
  "contactIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.seamless.ai/api/client/v2/campaigns"

payload = {
    "name": "Summer Outreach",
    "emailAccountIds": ["<string>"],
    "steps": [
        {
            "name": "<string>",
            "dueDay": 2,
            "description": "<string>",
            "templateId": "<string>"
        }
    ],
    "dailyTaskLimits": [
        {
            "dueDay": 2,
            "dailyTaskLimit": 2
        }
    ],
    "isDailyTaskLimitEnabled": True,
    "dailySendLimits": [
        {
            "emailAccountId": "<string>",
            "dailySendLimit": 1
        }
    ],
    "contactIds": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Summer Outreach',
    emailAccountIds: ['<string>'],
    steps: [{name: '<string>', dueDay: 2, description: '<string>', templateId: '<string>'}],
    dailyTaskLimits: [{dueDay: 2, dailyTaskLimit: 2}],
    isDailyTaskLimitEnabled: true,
    dailySendLimits: [{emailAccountId: '<string>', dailySendLimit: 1}],
    contactIds: ['<string>']
  })
};

fetch('https://api.seamless.ai/api/client/v2/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.seamless.ai/api/client/v2/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Summer Outreach',
    'emailAccountIds' => [
        '<string>'
    ],
    'steps' => [
        [
                'name' => '<string>',
                'dueDay' => 2,
                'description' => '<string>',
                'templateId' => '<string>'
        ]
    ],
    'dailyTaskLimits' => [
        [
                'dueDay' => 2,
                'dailyTaskLimit' => 2
        ]
    ],
    'isDailyTaskLimitEnabled' => true,
    'dailySendLimits' => [
        [
                'emailAccountId' => '<string>',
                'dailySendLimit' => 1
        ]
    ],
    'contactIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.seamless.ai/api/client/v2/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"Summer Outreach\",\n  \"emailAccountIds\": [\n    \"<string>\"\n  ],\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"dueDay\": 2,\n      \"description\": \"<string>\",\n      \"templateId\": \"<string>\"\n    }\n  ],\n  \"dailyTaskLimits\": [\n    {\n      \"dueDay\": 2,\n      \"dailyTaskLimit\": 2\n    }\n  ],\n  \"isDailyTaskLimitEnabled\": true,\n  \"dailySendLimits\": [\n    {\n      \"emailAccountId\": \"<string>\",\n      \"dailySendLimit\": 1\n    }\n  ],\n  \"contactIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.seamless.ai/api/client/v2/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Summer Outreach\",\n  \"emailAccountIds\": [\n    \"<string>\"\n  ],\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"dueDay\": 2,\n      \"description\": \"<string>\",\n      \"templateId\": \"<string>\"\n    }\n  ],\n  \"dailyTaskLimits\": [\n    {\n      \"dueDay\": 2,\n      \"dailyTaskLimit\": 2\n    }\n  ],\n  \"isDailyTaskLimitEnabled\": true,\n  \"dailySendLimits\": [\n    {\n      \"emailAccountId\": \"<string>\",\n      \"dailySendLimit\": 1\n    }\n  ],\n  \"contactIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.seamless.ai/api/client/v2/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Summer Outreach\",\n  \"emailAccountIds\": [\n    \"<string>\"\n  ],\n  \"steps\": [\n    {\n      \"name\": \"<string>\",\n      \"dueDay\": 2,\n      \"description\": \"<string>\",\n      \"templateId\": \"<string>\"\n    }\n  ],\n  \"dailyTaskLimits\": [\n    {\n      \"dueDay\": 2,\n      \"dailyTaskLimit\": 2\n    }\n  ],\n  \"isDailyTaskLimitEnabled\": true,\n  \"dailySendLimits\": [\n    {\n      \"emailAccountId\": \"<string>\",\n      \"dailySendLimit\": 1\n    }\n  ],\n  \"contactIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "campaign": {
      "campaignId": "1234",
      "name": "<string>",
      "identifier": "<string>",
      "status": "draft",
      "isPublic": true,
      "numContacts": 123,
      "numSteps": 123,
      "numDays": 123,
      "userIdOwner": "<string>",
      "ownerName": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "pausedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "emailAccountIds": [
        "<string>"
      ],
      "dailySendCapacity": 123,
      "dailySendLimits": [
        {
          "emailAccountId": 123,
          "email": "<string>",
          "dailySendLimit": 123,
          "sentToday": 123
        }
      ],
      "dailyTaskLimits": [
        {
          "dueDay": 123,
          "dailyTaskLimit": 123
        }
      ],
      "isDailyTaskLimitEnabled": true
    },
    "steps": [
      {
        "campaignStepId": "5678",
        "campaignId": "<string>",
        "type": "<string>",
        "name": "<string>",
        "description": "<string>",
        "status": "DRAFT",
        "stepNumber": 0,
        "dueDay": 123,
        "templateId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "contactsAdded": 123
  }
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

{
  "msg": "<string>",
  "code": "<string>"
}

MCP

API v1

API v2

Create a campaign

Authorizations

Scopes

Body

Response