API

We are excited to announce that our users can now take advantage of the MailScheduler API as part of our API-first strategy. This allows for seamless integration and automated scheduling of emails.

PreviousConfig NextTroubleshoot

Last updated 7 months ago

Was this helpful?

Authenticate and get a session token. This session token can be used for further authentication of all other requests.

post

/login

Authorizations

Body

emailstring

Example: john@company.com

passwordstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8000/api/login' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"email":"john@company.com"}'

200

401

{
  "token": "8|RSX9LwIKpiXdiMr73KOG0gpoEtD8LrMRLuhQOF8u98cfe793",
  "user": {
    "id": "1",
    "name": "John Doe",
    "email": "john@company.com",
    "email_verified_at": "null,",
    "is_admin": true,
    "created_at": "2023-10-03T08:16:46.000000Z",
    "updated_at": "2023-11-20T13:58:04.000000Z"
  }
}

Successful operation

List all schedules

Multiple status values can be provided with comma separated strings

get

/schedules

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8000/api/schedules' \
  --header 'Authorization: Bearer JWT'

200

[
  {
    "current_page": 1,
    "last_page": 5,
    "data": [
      {
        "id": 3,
        "label": "Weekly schedule",
        "admin_email": "admin@company.com",
        "testmode": true,
        "is_active": true,
        "created_at": "2024-01-01 09:10:00",
        "updated_at": "2024-01-01 09:10:00",
        "site_id": 2,
        "start_on": "2024-01-01",
        "end_on": "2024-12-31",
        "notify_on_failure": false,
        "tasks_count": 12,
        "active_tasks_count": 10,
        "upcoming": "2024-02-26 09:00:00",
        "frequencyString": "Days of the week: MON -> Dailyat: 09:00",
        "frequencies": "NA"
      }
    ]
  }
]

successful operation

View a task of a schedule

get

/schedules/{scheduleId}/tasks

Authorizations

Path parameters

scheduleIdstringrequired

Schedule ID

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8000/api/schedules/{scheduleId}/tasks' \
  --header 'Authorization: Bearer JWT'

200

404

500

{
  "recipient_count": 1,
  "mailinglists": [
    "5",
    "7"
  ],
  "label": "Sales overview",
  "filename": "Sales",
  "subject": "Weekly update",
  "from_email": "text",
  "from_name": "text",
  "reply_to_email": "text",
  "reply_to_name": "text",
  "active": true,
  "save": true,
  "notify_on_failure": true,
  "csv_delimiter": ",",
  "csv_extension": "csv",
  "send_type": "bcc",
  "views": [
    {
      "id": "text",
      "label": "text",
      "workbook_id": "text",
      "view_id": "text",
      "is_landscape": true,
      "order": 1,
      "export_types": 2,
      "filters": [
        {
          "id": "temp-key-234",
          "key": "Region",
          "value": "North"
        }
      ]
    }
  ],
  "emails": [
    {
      "email": "john@company.com"
    }
  ],
  "templates": [
    {
      "id": 1,
      "label": "company logo",
      "is_global": true,
      "body": "Hi {name}, Please see the overview below...",
      "img_id": 2,
      "img_url": "https://website.com/images/company-logo.png",
      "img_width": 200,
      "img_height": 200,
      "position": "header-right",
      "img_align": "right"
    }
  ]
}

successfully retrieved task

Add a task to a schedule'

post

/schedules/{scheduleId}/tasks

Authorizations

Path parameters

scheduleIdstringrequired

Schedule ID

Example: 1

Body

mailinglistsarray

Example: ["5","7"]

labelstring

A recognizable label for your reference

Example: Sales overview

filenamestring

The filename for the merged PDF.

Example: Sales

subjectstring

Subject of the email

Example: Weekly update

from_emailstring

Email address to use in the from email field. Note that you need permission with the authenticated email account to send an email with this email address.

from_namestring

Name from in the email

reply_to_emailstring

The reply to email address in the email

reply_to_namestring

The reply to name in the email

activeboolean

When the task is active, it will be sent once the schedule is executed.

Example: true

saveboolean

Save a copy of the PDF on your server

Example: true

notify_on_failureboolean

In case a task would fail, all recipients will get a notification that we were not able to send the email. We are aware of the issue and are working on it. This way we prevent that everyone will notify you about the failed email.

Example: true

csv_delimiterstring

The delimiter to be used in your csv export

Example: ,

csv_extensionstring

The extension for the csv export

Example: csv

send_typeenum

Send the email with the following method

Example: bcc

Options: to, cc, bcc

viewsobject[]

emailsarray

Example: [{"email":"john@company.com"}]

templatesobject[]

Templates are part of the email. You have templates for the headers and footers, but also for the main content of the email.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8000/api/schedules/{scheduleId}/tasks' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"mailinglists":["5","7"],"label":"Sales overview","filename":"Sales","subject":"Weekly update","active":true,"save":true,"notify_on_failure":true,"csv_delimiter":",","csv_extension":"csv","send_type":"bcc","views":[{"order":1,"export_types":2,"filters":[{"id":"temp-key-234","key":"Region","value":"North"}]}],"emails":[{"email":"john@company.com"}],"templates":[{"id":1,"label":"company logo","is_global":true,"body":"Hi {name}, Please see the overview below...","img_id":2,"img_url":"https://website.com/images/company-logo.png","img_width":200,"img_height":200,"position":"header-right","img_align":"right"}]}'

201

422

500

{
  "recipient_count": 1,
  "mailinglists": [
    "5",
    "7"
  ],
  "label": "Sales overview",
  "filename": "Sales",
  "subject": "Weekly update",
  "from_email": "text",
  "from_name": "text",
  "reply_to_email": "text",
  "reply_to_name": "text",
  "active": true,
  "save": true,
  "notify_on_failure": true,
  "csv_delimiter": ",",
  "csv_extension": "csv",
  "send_type": "bcc",
  "views": [
    {
      "id": "text",
      "label": "text",
      "workbook_id": "text",
      "view_id": "text",
      "is_landscape": true,
      "order": 1,
      "export_types": 2,
      "filters": [
        {
          "id": "temp-key-234",
          "key": "Region",
          "value": "North"
        }
      ]
    }
  ],
  "emails": [
    {
      "email": "john@company.com"
    }
  ],
  "templates": [
    {
      "id": 1,
      "label": "company logo",
      "is_global": true,
      "body": "Hi {name}, Please see the overview below...",
      "img_id": 2,
      "img_url": "https://website.com/images/company-logo.png",
      "img_width": 200,
      "img_height": 200,
      "position": "header-right",
      "img_align": "right"
    }
  ]
}

successfully created task

Update a task

put

/schedules/{scheduleId}/tasks/{taskId}

Authorizations

Path parameters

scheduleIdstringrequired

Schedule ID

Example: 1

taskIdstringrequired

Task ID

Example: 1

Body

mailinglistsarray

Example: ["5","7"]

labelstring

A recognizable label for your reference

Example: Sales overview

filenamestring

The filename for the merged PDF.

Example: Sales

subjectstring

Subject of the email

Example: Weekly update

from_emailstring

Email address to use in the from email field. Note that you need permission with the authenticated email account to send an email with this email address.

from_namestring

Name from in the email

reply_to_emailstring

The reply to email address in the email

reply_to_namestring

The reply to name in the email

activeboolean

When the task is active, it will be sent once the schedule is executed.

Example: true

saveboolean

Save a copy of the PDF on your server

Example: true

notify_on_failureboolean

Example: true

csv_delimiterstring

The delimiter to be used in your csv export

Example: ,

csv_extensionstring

The extension for the csv export

Example: csv

send_typeenum

Send the email with the following method

Example: bcc

Options: to, cc, bcc

viewsobject[]

emailsarray

Example: [{"email":"john@company.com"}]

templatesobject[]

Templates are part of the email. You have templates for the headers and footers, but also for the main content of the email.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8000/api/schedules/{scheduleId}/tasks/{taskId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"mailinglists":["5","7"],"label":"Sales overview","filename":"Sales","subject":"Weekly update","active":true,"save":true,"notify_on_failure":true,"csv_delimiter":",","csv_extension":"csv","send_type":"bcc","views":[{"order":1,"export_types":2,"filters":[{"id":"temp-key-234","key":"Region","value":"North"}]}],"emails":[{"email":"john@company.com"}],"templates":[{"id":1,"label":"company logo","is_global":true,"body":"Hi {name}, Please see the overview below...","img_id":2,"img_url":"https://website.com/images/company-logo.png","img_width":200,"img_height":200,"position":"header-right","img_align":"right"}]}'

200

404

422

500

No body

successfully updated

Delete a task

delete

/schedules/{scheduleId}/tasks/{taskId}

Authorizations

Path parameters

scheduleIdstringrequired

Schedule ID

Example: 1

taskIdstringrequired

Task ID

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8000/api/schedules/{scheduleId}/tasks/{taskId}' \
  --header 'Authorization: Bearer JWT'

200

404

500

No body

successfully deleted task

Get all mailinglists

get

/mailing-lists

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8000/api/mailing-lists' \
  --header 'Authorization: Bearer JWT'

200

{
  "data": null
}

Get all mailinglists

Create a new mailinglist

post

/mailing-lists

Authorizations

Body

namestring

The label of the mailinglist

Example: Managers

descriptionstring

A description for the mailinglist

Example: Managers from region West

sitesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8000/api/mailing-lists' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Managers","description":"Managers from region West","sites":[]}'

201

422

500

No body

Create a new mailinglist

Update a mailinglist

put

/mailing-lists/{mailinglistId}

Authorizations

Path parameters

mailinglistIdstringrequired

Mailinglist ID

Example: 1

Body

namestring

The label of the mailinglist

Example: Managers

descriptionstring

A description for the mailinglist

Example: Managers from region West

sitesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8000/api/mailing-lists/{mailinglistId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Managers","description":"Managers from region West","sites":[]}'

200

404

422

500

No body

Update a mailinglist

Delete a mailinglist

delete

/mailing-lists/{mailinglistId}

Authorizations

Path parameters

mailinglistIdstringrequired

Mailinglist ID

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8000/api/mailing-lists/{mailinglistId}' \
  --header 'Authorization: Bearer JWT'

200

404

500

No body

successfully deleted mailinglist

Get all recipients

get

/recipients

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8000/api/recipients' \
  --header 'Authorization: Bearer JWT'

200

{
  "current_page": 1,
  "last_page": 5,
  "data": [
    {
      "name": "John Doe",
      "email": "john@company.com",
      "created_at": "2024-01-17T09:45:14.000000Z",
      "updated_at": "2024-01-17T09:45:14.000000Z",
      "filters": [
        {
          "id": "temp-key-234",
          "key": "Region",
          "value": "North"
        }
      ],
      "placeholders": [
        {
          "id": 1,
          "key": "name",
          "value": "John Doe"
        }
      ],
      "mailinglists": [
        5
      ],
      "sites": []
    }
  ]
}

Get all recipients

Create a recipient

post

/recipients

Authorizations

Body

namestring

Name of the recipient. Primarely used for your reference, but acts as a fallback when you use the "name" placeholder

Example: John Doe

emailstring

Emailaddress of the recipient

Example: john@company.com

filtersobject[]

placeholdersobject[]

mailinglistsstring[]

sitesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8000/api/recipients' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"John Doe","email":"john@company.com","filters":[{"id":"temp-key-234","key":"Region","value":"North"}],"placeholders":[{"id":1,"key":"name","value":"John Doe"}],"mailinglists":[5],"sites":[]}'

201

422

500

{
  "name": "John Doe",
  "email": "john@company.com",
  "created_at": "2024-01-17T09:45:14.000000Z",
  "updated_at": "2024-01-17T09:45:14.000000Z",
  "filters": [
    {
      "id": "temp-key-234",
      "key": "Region",
      "value": "North"
    }
  ],
  "placeholders": [
    {
      "id": 1,
      "key": "name",
      "value": "John Doe"
    }
  ],
  "mailinglists": [
    5
  ],
  "sites": []
}

Store a new recipient

Update a recipient

put

/recipients/{recipientId}

Authorizations

Path parameters

recipientIdstringrequired

Recipient ID

Example: 1

Body

namestring

Name of the recipient. Primarely used for your reference, but acts as a fallback when you use the "name" placeholder

Example: John Doe

emailstring

Emailaddress of the recipient

Example: john@company.com

filtersobject[]

placeholdersobject[]

mailinglistsstring[]

sitesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8000/api/recipients/{recipientId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"John Doe","email":"john@company.com","filters":[{"id":"temp-key-234","key":"Region","value":"North"}],"placeholders":[{"id":1,"key":"name","value":"John Doe"}],"mailinglists":[5],"sites":[]}'

200

404

422

500

No body

successfully updated recipient

Delete a recipient

delete

/recipients/{recipientId}

Authorizations

Path parameters

recipientIdstringrequired

Recipient ID

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8000/api/recipients/{recipientId}' \
  --header 'Authorization: Bearer JWT'

200

422

500

No body

successfully deleted recipient

get

/sites

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8000/api/sites' \
  --header 'Authorization: Bearer JWT'

200

[
  {
    "site_name": "companyname",
    "token_id": "1",
    "server_id": 1,
    "id": "text",
    "label": "text"
  }
]

Get all sites

post

/tableau/get-workbook-id/{siteId}

Authorizations

Path parameters

siteIdstringrequired

Site ID, required to access Tableau

Example: 1

Body

namestring

The name of the workbook

Example: MyWorkbook

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8000/api/tableau/get-workbook-id/{siteId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"MyWorkbook"}'

200

{
  "workbookd_id": "3a051b9c-e21a-4a77-b809-6d2d0a9f2305"
}

Get back the workbook ID from Tableau

post

/tableau/get-view-id/{siteId}

Authorizations

Path parameters

siteIdstringrequired

Site ID, required to access Tableau

Example: 1

Body

namestring

The name of the Dashboard or view

Example: MyDashboardName

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8000/api/tableau/get-view-id/{siteId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"MyDashboardName"}'

200

{
  "view_id": "3a051b9c-e21a-4a77-b809-6d2d0a9f2305"
}

Get back the view ID from Tableau