Create Campaign

POST 
https://api.tinyemail.com/v1/campaign

Create a new campaign

• contentSourceUrl - While adding campaign into system we will verify contentSourceUrl. If verification is failed, we will abort the campaign creation process.
• contactIds - Contact Ids. Refer Contacts API
• schedule.dateTime - Campaign schedule time in UTC
• schedule.days - Recurring campaign days
• schedule.time - Recurring campaign time in HH:mm:ss format

Campaign Status Scenarios:

1. Draft Campaign (No Schedule Provided):
   • If the schedule object is not included in the payload, the campaign will be in the Draft status. This means the campaign is saved but not scheduled for delivery yet.
2. Scheduled Campaign (DateTime Provided):
   • If the schedule object is present, and it has a non-empty dateTime field, the campaign will be in the Scheduled status. This indicates that the campaign is scheduled for delivery at the specified date and time.
3. Recurring Campaign (Days and Time Provided):
   • If the schedule object has days and time specified, the campaign will be in the Recurring status. This means the campaign is set to recur on the specified days at the provided time.

Request

application/json

Body

required

contentSourceUrl string
campaign objectrequired
name stringrequired
subject stringrequired
previewText string
senderId uuidrequired
template objectrequired
html stringrequired
contactIds string[]
schedule object
dateTime string
days string[]
time string

Responses

200

Successful operation
The status could be one of

• DRAFT - The campaign will be this state until client confirms sender details through email
• SCHEDULED - campaign successfully scheduled in our system
• LAUNCHED - campaign is launched at the specified date/time
• COMPLETED - will only be in case when campaign is scheduled for type - ONCE
• PAUSED - When campaign is PAUSED
• FAILED - will be FAILED, after launching a campaign if contentSourceURL is not present or down or we receive invalid content from this URL.

application/json

Schema

Schema

id uuid
status string

Example (from schema)

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "DRAFT"
}

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Some error message"
}

401

API key is missing or invalid

405

Method Not Allowed

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyin: header

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://api.tinyemail.com/v1/campaign' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-KEY: <API_KEY_VALUE>' \
--data-raw '{
  "contentSourceUrl": "https://app.tinyemail.com/api/v1/content.json",
  "campaign": {
    "name": "Black Friday Campaign",
    "subject": "Black Friday Offer",
    "previewText": "Offer!"
  },
  "senderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "template": {
    "html": ""
  },
  "contactIds": [
    [
      "2b4ea4a6-1fa3-4863-87e7-f498376d68",
      "b85a7177-b94b-43de-a8cd-03713c91b"
    ]
  ],
  "schedule": {
    "dateTime": "2024-01-26T08:15:00.00Z",
    "days": [
      [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ]
    ],
    "time": "03:00:00"
  }
}'

Request Collapse all

Base URL

https://api.tinyemail.com/v1

Auth

api_key

Body required

{
  "contentSourceUrl": "https://app.tinyemail.com/api/v1/content.json",
  "campaign": {
    "name": "Black Friday Campaign",
    "subject": "Black Friday Offer",
    "previewText": "Offer!"
  },
  "senderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "template": {
    "html": ""
  },
  "contactIds": [
    [
      "2b4ea4a6-1fa3-4863-87e7-f498376d68",
      "b85a7177-b94b-43de-a8cd-03713c91b"
    ]
  ],
  "schedule": {
    "dateTime": "2024-01-26T08:15:00.00Z",
    "days": [
      [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ]
    ],
    "time": "03:00:00"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!