Sign in
latestOpenAPI 3.0.02026-08-10171532.2 KB

c6c3717d477d

Task

View a task of a schedule

get/schedules/{scheduleId}/tasks

Path parameters

scheduleIdstring required

Schedule ID

Response

successfully retrieved task

recipient_countinteger
labelstring

A recognizable label for your reference

filenamestring

The filename for the merged PDF.

subjectstring

Subject of the email

send_type'to' | 'cc' | 'bcc'

Send the email with the following method

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.

saveboolean

Save a copy of the PDF on your server

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.

csv_delimiterstring

The delimiter to be used in your csv export

csv_extensionstring

The extension for the csv export

Example response

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