Campaign API

A campaign is the configuration for sending out messages. Campaigns need senders, messages, and contacts in order to work properly.

Create a Campaign

Create a campaign with a TeamId and a name

curl 'https://api.supersend.io/v1/auto/campaign' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "name": "My Campaign",
  "TeamId": "<TEAM_ID>"
}'

Get Campaigns

overview - if set to true will provide campaign highlights

curl -X GET 'https://api.supersend.io/v1/auto/campaigns?TeamId=xxx&CampaignId=xxx&overview=<boolean>' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Get Campaign

Returns the campaign with performance stats

curl -X GET 'https://api.supersend.io/v1/auto/campaign/<CampaignId>?TeamId=xxx' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Update Campaign

curl -X PUT https://api.supersend.io/v1/auto/campaign/<CampaignId> \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-D '{ \
  "default":false, \
  "name":"4. Twitter - mailshake", \
  "warm":false, \
  "unsubscribe":true, \
  "max_per_day":25, \
  "max_per_day_twitter":50, \
  "unsubscribe_message":"string", \
  "hours": [{ start: "09:00", end: "15:00" }], \
  "status":1, \
  "LinkedinId":"XXX", \
  "TwitterId":"XXX", \
  "SenderIds": ["XXX"], \
  "TeamId":"XXX", \
  "CampaignId":"XXX" \
  "days": { \
    "friday": true, \
    "monday": true, \
    "sunday": false, \
    "tuesday": true, \
    "saturday": false, \
    "thursday": true, \
    "wednesday": true \
  },
}'

Delete Campaign

curl -X DELETE https://api.supersend.io/v1/auto/campaign/<CampaignId> \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"