Mailchimp Transactional (Mandrill)

App · 20 actions

Send transactional email, manage templates and scheduled messages, and inspect senders and rejections.

Actions

ActionWhat it does
Add rejectionAdd rejection in Mailchimp Transactional (Mandrill).
Cancel scheduled messageCancel scheduled message in Mailchimp Transactional (Mandrill).
Create templateCreate template in Mailchimp Transactional (Mandrill).
Delete rejectionDelete rejection in Mailchimp Transactional (Mandrill).
Delete templateDelete template in Mailchimp Transactional (Mandrill).
Get accountGet account in Mailchimp Transactional (Mandrill).
Get messageGet message in Mailchimp Transactional (Mandrill).
Get templateGet template in Mailchimp Transactional (Mandrill).
List rejectionsList rejections in Mailchimp Transactional (Mandrill).
List scheduled messagesList scheduled messages in Mailchimp Transactional (Mandrill).
List sendersList senders in Mailchimp Transactional (Mandrill).
List sending domainsList sending domains in Mailchimp Transactional (Mandrill).
List tagsList tags in Mailchimp Transactional (Mandrill).
List templatesList templates in Mailchimp Transactional (Mandrill).
Render templateRender template in Mailchimp Transactional (Mandrill).
Reschedule messageReschedule message in Mailchimp Transactional (Mandrill).
Search messagesSearch messages in Mailchimp Transactional (Mandrill).
Send messageSend message in Mailchimp Transactional (Mandrill).
Send templateSend template in Mailchimp Transactional (Mandrill).
Update templateUpdate template in Mailchimp Transactional (Mandrill).

Add rejection

Add rejection in Mailchimp Transactional (Mandrill).

Inputs

EmailemailtextRequired
An email address to block
Commentcommenttext
An optional comment describing the rejection
Subaccountsubaccounttext
An optional unique identifier for the subaccount to limit the blacklist entry

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "added": false,
    "email": "example"
  }
}

Cancel scheduled message

Cancel scheduled message in Mailchimp Transactional (Mandrill).

Inputs

IdidtextRequired
a scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "_id": "example",
    "created_at": "example",
    "from_email": "example",
    "send_at": "example",
    "subject": "example",
    "to": "example"
  }
}

Create template

Create template in Mailchimp Transactional (Mandrill).

Inputs

NamenametextRequired
Name for the new template - must be unique
From emailfrom_emailtext
Default sending address for emails sent using this template
From namefrom_nametext
Default from name to be used
Subjectsubjecttext
Default subject line to be used
Codecodetext
HTML code for the template with mc:edit attributes for editable elements
Texttexttext
Default text part to be used when sending with this template
Publishpublishtrue/false
Set to false to add a draft template without publishing
Labelslabelslist
Optional array of up to 10 labels to use for filtering templates

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "code": "example",
    "created_at": "example",
    "draft_updated_at": "example",
    "from_email": "example",
    "from_name": "example",
    "is_broken_template": false,
    "labels": [],
    "name": "example",
    "publish_code": "example",
    "publish_from_email": "example",
    "publish_from_name": "example",
    "publish_name": "example",
    "publish_subject": "example",
    "publish_text": "example",
    "published_at": "example",
    "slug": "example",
    "subject": "example",
    "text": "example",
    "updated_at": "example"
  }
}

Delete rejection

Delete rejection in Mailchimp Transactional (Mandrill).

Inputs

EmailemailtextRequired
An email address to remove from the blacklist
Subaccountsubaccounttext
An optional unique identifier for the subaccount to limit the blacklist deletion

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "deleted": false,
    "email": "example",
    "subaccount": "example"
  }
}

Delete template

Delete template in Mailchimp Transactional (Mandrill).

Inputs

NamenametextRequired
Immutable slug of an existing template

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "code": "example",
    "created_at": "example",
    "draft_updated_at": "example",
    "from_email": "example",
    "from_name": "example",
    "is_broken_template": false,
    "labels": [],
    "name": "example",
    "publish_code": "example",
    "publish_from_email": "example",
    "publish_from_name": "example",
    "publish_name": "example",
    "publish_subject": "example",
    "publish_text": "example",
    "published_at": "example",
    "slug": "example",
    "subject": "example",
    "text": "example",
    "updated_at": "example"
  }
}

Get account

Get account in Mailchimp Transactional (Mandrill).

Inputs

None.

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "backlog": 1,
    "created_at": "example",
    "hourly_quota": 1,
    "public_id": "example",
    "reputation": 1,
    "stats": {
      "all_time": {
        "clicks": 1,
        "complaints": 1,
        "hard_bounces": 1,
        "opens": 1,
        "rejects": 1,
        "sent": 1,
        "soft_bounces": 1,
        "unique_clicks": 1,
        "unique_opens": 1,
        "unsubs": 1
      },
      "last_30_days": {
        "clicks": 1,
        "complaints": 1,
        "hard_bounces": 1,
        "opens": 1,
        "rejects": 1,
        "sent": 1,
        "soft_bounces": 1,
        "unique_clicks": 1,
        "unique_opens": 1,
        "unsubs": 1
      },
      "last_60_days": {
        "clicks": 1,
        "complaints": 1,
        "hard_bounces": 1,
        "opens": 1,
        "rejects": 1,
        "sent": 1,
        "soft_bounces": 1,
        "unique_clicks": 1,
        "unique_opens": 1,
        "unsubs": 1
      },
      "last_7_days": {
        "clicks": 1,
        "complaints": 1,
        "hard_bounces": 1,
        "opens": 1,
        "rejects": 1,
        "sent": 1,
        "soft_bounces": 1,
        "unique_clicks": 1,
        "unique_opens": 1,
        "unsubs": 1
      },
      "last_90_days": {
        "clicks": 1,
        "complaints": 1,
        "hard_bounces": 1,
        "opens": 1,
        "rejects": 1,
        "sent": 1,
        "soft_bounces": 1,
        "unique_clicks": 1,
        "unique_opens": 1,
        "unsubs": 1
      },
      "today": {
        "clicks": 1,
        "complaints": 1,
        "hard_bounces": 1,
        "opens": 1,
        "rejects": 1,
        "sent": 1,
        "soft_bounces": 1,
        "unique_clicks": 1,
        "unique_opens": 1,
        "unsubs": 1
      }
    },
    "username": "example"
  }
}

Get message

Get message in Mailchimp Transactional (Mandrill).

Inputs

IdidtextRequired
the unique id of the message to get - passed as the "_id" field in webhooks, send calls, or search calls

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "_id": "example",
    "bounce_description": "example",
    "clicks": 1,
    "clicks_detail": [],
    "diag": "example",
    "email": "example",
    "mc_template": "example",
    "metadata": "example",
    "opens": 1,
    "opens_detail": [],
    "reject": "example",
    "resends": [],
    "sender": "example",
    "smtp_events": [],
    "state": "example",
    "subaccount": "example",
    "subject": "example",
    "tags": [],
    "template": "example",
    "ts": 1
  }
}

Get template

Get template in Mailchimp Transactional (Mandrill).

Inputs

NamenametextRequired
Immutable name of an existing template

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "code": "example",
    "created_at": "example",
    "draft_updated_at": "example",
    "from_email": "example",
    "from_name": "example",
    "is_broken_template": false,
    "labels": [],
    "name": "example",
    "publish_code": "example",
    "publish_from_email": "example",
    "publish_from_name": "example",
    "publish_name": "example",
    "publish_subject": "example",
    "publish_text": "example",
    "published_at": "example",
    "slug": "example",
    "subject": "example",
    "text": "example",
    "updated_at": "example"
  }
}

List rejections

List rejections in Mailchimp Transactional (Mandrill).

Inputs

Emailemailtext
An optional email address to search by
Include expiredinclude_expiredtrue/false
Whether to include rejections that have already expired
Subaccountsubaccounttext
An optional unique identifier for the subaccount to limit the blacklist

Outputs

datalist
Mailchimp Transactional (Mandrill) response data.
has_moretrue/false
Whether another page is available.
may_be_truncatedtrue/false
The API result limit was reached; narrow the search to ensure complete results.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": [],
  "has_more": false,
  "may_be_truncated": false,
  "next_cursor": null,
  "records": []
}

List scheduled messages

List scheduled messages in Mailchimp Transactional (Mandrill).

Inputs

Tototext
an optional recipient address to restrict results to

Outputs

datalist
Mailchimp Transactional (Mandrill) response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List senders

List senders in Mailchimp Transactional (Mandrill).

Inputs

None.

Outputs

datalist
Mailchimp Transactional (Mandrill) response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List sending domains

List sending domains in Mailchimp Transactional (Mandrill).

Inputs

None.

Outputs

datalist
Mailchimp Transactional (Mandrill) response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List tags

List tags in Mailchimp Transactional (Mandrill).

Inputs

None.

Outputs

datalist
Mailchimp Transactional (Mandrill) response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List templates

List templates in Mailchimp Transactional (Mandrill).

Inputs

Labellabeltext
Optional label to filter the templates

Outputs

datalist
Mailchimp Transactional (Mandrill) response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Render template

Render template in Mailchimp Transactional (Mandrill).

Inputs

Template nametemplate_nametextRequired
Immutable name or slug of a template that exists in the user's account
Template contenttemplate_contentlistRequired
Array of template content to render
Merge varsmerge_varslist
Optional merge variables to use for injecting merge field content

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "html": "example"
  }
}

Reschedule message

Reschedule message in Mailchimp Transactional (Mandrill).

Inputs

IdidtextRequired
a scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled
Send atsend_atdate and timeRequired
the new UTC timestamp when the message should sent. Mandrill can't time travel, so if you specify a time in past the message will be sent immediately

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "_id": "example",
    "created_at": "example",
    "from_email": "example",
    "send_at": "example",
    "subject": "example",
    "to": "example"
  }
}

Search messages

Search messages in Mailchimp Transactional (Mandrill).

Inputs

Queryquerytext
search terms to find matching messages
Date fromdate_fromdate
start date
Date todate_todate
end date
Tagstagslist
an array of tag names to narrow the search to
Senderssenderslist
an array of sender addresses to narrow the search to
Api keysapi_keyslist
an array of API keys to narrow the search to
Limitlimitnumber
the maximum number of results to return, defaults to 100, upper limit of 1000At most 1000. Default: 100.

Outputs

datalist
Mailchimp Transactional (Mandrill) response data.
has_moretrue/false
Whether another page is available.
may_be_truncatedtrue/false
The API result limit was reached; narrow the search to ensure complete results.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": [],
  "has_more": false,
  "may_be_truncated": false,
  "next_cursor": null,
  "records": []
}

Send message

Send message in Mailchimp Transactional (Mandrill).

Inputs

Htmlhtmltext
the full HTML content to be sent
Texttexttext
optional full text content to be sent
Subjectsubjecttext
the message subject
From emailfrom_emailtextRequired
the sender email address
From namefrom_nametext
optional from name to be used
TotolistRequired
an array of recipient information.
Track openstrack_openstrue/false
whether or not to turn on open tracking for the message
Track clickstrack_clickstrue/false
whether or not to turn on click tracking for the message
Merge languagemerge_languagetext
the merge tag language to use when evaluating merge tags, either mailchimp or handlebars Possible values: "mailchimp" or "handlebars".One of: mailchimp, handlebars.
Global merge varsglobal_merge_varslist
global merge variables to use for all recipients. You can override these per recipient.
Merge varsmerge_varslist
per-recipient merge variables, which override global merge variables with the same name.
Tagstagslist
an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.
Metadatametadataobject
metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.
Attachmentsattachmentslist
an array of supported attachments to add to the message
Async modeasync_modetrue/false
enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
Ip poolip_pooltext
the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
Send atsend_atdate and time
when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately; for future dates, you're limited to one year from the date of scheduling.

Outputs

datalist
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": []
}

Send template

Send template in Mailchimp Transactional (Mandrill).

Inputs

Template nametemplate_nametextRequired
the immutable slug of a template that exists in the user's account. Make sure you don't use the template name as this one might change.
Template contenttemplate_contentlistRequired
an array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block
Htmlhtmltext
the full HTML content to be sent
Texttexttext
optional full text content to be sent
Subjectsubjecttext
the message subject
From emailfrom_emailtextRequired
the sender email address
From namefrom_nametext
optional from name to be used
TotolistRequired
an array of recipient information.
Track openstrack_openstrue/false
whether or not to turn on open tracking for the message
Track clickstrack_clickstrue/false
whether or not to turn on click tracking for the message
Merge languagemerge_languagetext
the merge tag language to use when evaluating merge tags, either mailchimp or handlebars Possible values: "mailchimp" or "handlebars".One of: mailchimp, handlebars.
Global merge varsglobal_merge_varslist
global merge variables to use for all recipients. You can override these per recipient.
Merge varsmerge_varslist
per-recipient merge variables, which override global merge variables with the same name.
Tagstagslist
an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.
Metadatametadataobject
metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.
Attachmentsattachmentslist
an array of supported attachments to add to the message
Async modeasync_modetrue/false
enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
Ip poolip_pooltext
the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
Send atsend_atdate and time
when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately; for future dates, you're limited to one year from the date of scheduling.

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {}
}

Update template

Update template in Mailchimp Transactional (Mandrill).

Inputs

NamenametextRequired
Immutable name of an existing template
From emailfrom_emailtext
New default sending address
From namefrom_nametext
New default from name
Subjectsubjecttext
New default subject line
Codecodetext
New code for the template
Texttexttext
New default text part to be used
Publishpublishtrue/false
Set to false to update the draft version without publishing
Labelslabelslist
Optional array of up to 10 labels to use for filtering templates

Outputs

dataobject
Mailchimp Transactional (Mandrill) response data.
Example output
{
  "data": {
    "code": "example",
    "created_at": "example",
    "draft_updated_at": "example",
    "from_email": "example",
    "from_name": "example",
    "is_broken_template": false,
    "labels": [],
    "name": "example",
    "publish_code": "example",
    "publish_from_email": "example",
    "publish_from_name": "example",
    "publish_name": "example",
    "publish_subject": "example",
    "publish_text": "example",
    "published_at": "example",
    "slug": "example",
    "subject": "example",
    "text": "example",
    "updated_at": "example"
  }
}

On this page