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.

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

POSThttp://localhost:8000/api/login

Body

Get a session token

emailstring

Example: "john@company.com"

passwordstring

Response

Auth response. Find the token here and use this as authentication for the other requests.

Body

userobject

tokenstring

Example: "21|wefoefkweofkewf324903kefl"

Request

const response = await fetch('http://localhost:8000/api/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "user": {
    "id": "text",
    "name": "text",
    "email": "text",
    "email_verified_at": "text",
    "is_admin": "text",
    "created_at": "text",
    "updated_at": "text"
  },
  "token": "21|wefoefkweofkewf324903kefl"
}

List all schedules

Multiple status values can be provided with comma separated strings

GEThttp://localhost:8000/api/schedules

Response

successful operation

Body

dataarray of Schedule (object)

current_pageinteger

Example: 1

last_pageinteger

Example: 5

Request

const response = await fetch('http://localhost:8000/api/schedules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "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"
      }
    ],
    "current_page": 1,
    "last_page": 5
  }
]

View a task of a schedule

GEThttp://localhost:8000/api/schedules/{scheduleId}/tasks

Path parameters

scheduleId*string

Schedule ID

Example: 1

Response

successfully retrieved task

Body

recipient_countinteger

Example: 1

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"

mailinglistsarray

emailsarray

send_typeenum

Send the email with the following method

Example: "bcc"

toccbcc

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"

viewsarray of View (object)

templatesarray of Template (object)

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

Request

const response = await fetch('http://localhost:8000/api/schedules/{scheduleId}/tasks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "recipient_count": 1,
  "label": "Sales overview",
  "filename": "Sales",
  "subject": "Weekly update",
  "mailinglists": [
    "5",
    "7"
  ],
  "emails": [
    {
      "email": "john@company.com"
    }
  ],
  "send_type": "bcc",
  "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",
  "views": [
    {
      "id": "text",
      "label": "text",
      "workbook_id": "text",
      "view_id": "text",
      "is_landscape": false,
      "order": 1,
      "export_types": 2,
      "filters": [
        {
          "id": "temp-key-234",
          "key": "Region",
          "value": "North"
        }
      ]
    }
  ],
  "templates": [
    {
      "id": 1,
      "label": "company logo",
      "position": "header-right",
      "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,
      "img_align": "right"
    }
  ]
}

Add a task to a schedule'

POSThttp://localhost:8000/api/schedules/{scheduleId}/tasks

Path parameters

scheduleId*string

Schedule ID

Example: 1

Body

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"

mailinglistsarray

emailsarray

send_typeenum

Send the email with the following method

Example: "bcc"

toccbcc

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"

viewsarray of View (object)

templatesarray of Template (object)

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

Response

successfully created task

Body

recipient_countinteger

Example: 1

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"

mailinglistsarray

emailsarray

send_typeenum

Send the email with the following method

Example: "bcc"

toccbcc

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"

viewsarray of View (object)

templatesarray of Template (object)

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

Request

const response = await fetch('http://localhost:8000/api/schedules/{scheduleId}/tasks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "recipient_count": 1,
  "label": "Sales overview",
  "filename": "Sales",
  "subject": "Weekly update",
  "mailinglists": [
    "5",
    "7"
  ],
  "emails": [
    {
      "email": "john@company.com"
    }
  ],
  "send_type": "bcc",
  "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",
  "views": [
    {
      "id": "text",
      "label": "text",
      "workbook_id": "text",
      "view_id": "text",
      "is_landscape": false,
      "order": 1,
      "export_types": 2,
      "filters": [
        {
          "id": "temp-key-234",
          "key": "Region",
          "value": "North"
        }
      ]
    }
  ],
  "templates": [
    {
      "id": 1,
      "label": "company logo",
      "position": "header-right",
      "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,
      "img_align": "right"
    }
  ]
}

Update a task

PUThttp://localhost:8000/api/schedules/{scheduleId}/tasks/{taskId}

Path parameters

scheduleId*string

Schedule ID

Example: 1

taskId*string

Task ID

Example: 1

Body

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"

mailinglistsarray

emailsarray

send_typeenum

Send the email with the following method

Example: "bcc"

toccbcc

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"

viewsarray of View (object)

templatesarray of Template (object)

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

Response

successfully updated

Request

const response = await fetch('http://localhost:8000/api/schedules/{scheduleId}/tasks/{taskId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": false,
  "status_code": 500,
  "reason_phrase": "Reason phrase"
}

Delete a task

DELETEhttp://localhost:8000/api/schedules/{scheduleId}/tasks/{taskId}

Path parameters

scheduleId*string

Schedule ID

Example: 1

taskId*string

Task ID

Example: 1

Response

successfully deleted task

Request

const response = await fetch('http://localhost:8000/api/schedules/{scheduleId}/tasks/{taskId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "status": false,
  "status_code": 500,
  "reason_phrase": "Reason phrase"
}

Get all mailinglists

GEThttp://localhost:8000/api/mailing-lists

Response

Get all mailinglists

Body

object

Request

const response = await fetch('http://localhost:8000/api/mailing-lists', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Create a new mailinglist

POSThttp://localhost:8000/api/mailing-lists

Body

Request for mailinglist

namestring

The label of the mailinglist

Example: "Managers"

descriptionstring

A description for the mailinglist

Example: "Managers from region West"

sitesarray of object

Response

Create a new mailinglist

Body

MailinglistResponse (any)

Mailinglist Response.

Request

const response = await fetch('http://localhost:8000/api/mailing-lists', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "The X field is required. (and 2 more errors)",
  "errors": [
    {
      "fieldname": [
        "The X field is required."
      ]
    }
  ]
}

Update a mailinglist

PUThttp://localhost:8000/api/mailing-lists/{mailinglistId}

Path parameters

mailinglistId*string

Mailinglist ID

Example: 1

Body

Request for mailinglist

namestring

The label of the mailinglist

Example: "Managers"

descriptionstring

A description for the mailinglist

Example: "Managers from region West"

sitesarray of object

Response

Update a mailinglist

Body

MailinglistResponse (any)

Mailinglist Response.

Request

const response = await fetch('http://localhost:8000/api/mailing-lists/{mailinglistId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": false,
  "status_code": 500,
  "reason_phrase": "Reason phrase"
}

Delete a mailinglist

DELETEhttp://localhost:8000/api/mailing-lists/{mailinglistId}

Path parameters

mailinglistId*string

Mailinglist ID

Example: 1

Response

successfully deleted mailinglist

Request

const response = await fetch('http://localhost:8000/api/mailing-lists/{mailinglistId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "status": false,
  "status_code": 500,
  "reason_phrase": "Reason phrase"
}

Get all recipients

GEThttp://localhost:8000/api/recipients

Response

Get all recipients

Body

dataarray of Recipient (object)

current_pageinteger

Example: 1

last_pageinteger

Example: 5

Request

const response = await fetch('http://localhost:8000/api/recipients', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
        }
      ],
      "sites": [
        {
          "id": "text"
        }
      ],
      "mailinglists": [
        5
      ],
      "created_at": "2024-01-17T09:45:14.000000Z",
      "updated_at": "2024-01-17T09:45:14.000000Z"
    }
  ],
  "current_page": 1,
  "last_page": 5
}

Create a recipient

POSThttp://localhost:8000/api/recipients

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"

filtersarray of Filter (object)

placeholdersarray of Placeholder (object)

sitesarray of object

mailinglistsarray of string

Response

Store a new recipient

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"

filtersarray of Filter (object)

placeholdersarray of Placeholder (object)

sitesarray of object

mailinglistsarray of string

created_atstring

Created at timestamp

Example: "2024-01-17T09:45:14.000000Z"

updated_atstring

Updated at timestamp

Example: "2024-01-17T09:45:14.000000Z"

Request

const response = await fetch('http://localhost:8000/api/recipients', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Update a recipient

PUThttp://localhost:8000/api/recipients/{recipientId}

Path parameters

recipientId*string

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"

filtersarray of Filter (object)

placeholdersarray of Placeholder (object)

sitesarray of object

mailinglistsarray of string

Response

successfully updated recipient

Request

const response = await fetch('http://localhost:8000/api/recipients/{recipientId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": false,
  "status_code": 500,
  "reason_phrase": "Reason phrase"
}

Delete a recipient

DELETEhttp://localhost:8000/api/recipients/{recipientId}

Path parameters

recipientId*string

Recipient ID

Example: 1

Response

successfully deleted recipient

Request

const response = await fetch('http://localhost:8000/api/recipients/{recipientId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "The X field is required. (and 2 more errors)",
  "errors": [
    {
      "fieldname": [
        "The X field is required."
      ]
    }
  ]
}

GEThttp://localhost:8000/api/sites

Response

Get all sites

Body

idstring

site ID

labelstring

site label

site_namestring

Example: "companyname"

token_idstring

Example: "1"

server_idstring

Example: 1

Request

const response = await fetch('http://localhost:8000/api/sites', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

POSThttp://localhost:8000/api/tableau/get-workbook-id/{siteId}

Path parameters

siteId*string

Site ID, required to access Tableau

Example: 1

Body

Request to find workbook ID from Tableau.

namestring

The name of the workbook

Example: "MyWorkbook"

Response

Get back the workbook ID from Tableau

Body

workbookd_idstring

Example: "3a051b9c-e21a-4a77-b809-6d2d0a9f2305"

Request

const response = await fetch('http://localhost:8000/api/tableau/get-workbook-id/{siteId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

POSThttp://localhost:8000/api/tableau/get-view-id/{siteId}

Path parameters

siteId*string

Site ID, required to access Tableau

Example: 1

Body

Request to find view ID from Tableau.

namestring

The name of the Dashboard or view

Example: "MyDashboardName"

Response

Get back the view ID from Tableau

Body

view_idstring

Example: "3a051b9c-e21a-4a77-b809-6d2d0a9f2305"

Request

const response = await fetch('http://localhost:8000/api/tableau/get-view-id/{siteId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

PreviousConfig NextTroubleshoot

Last updated 2 months ago