API ReferencePlatform

Mailer

Email batches and the emails sent in them.

Prefix /cdna-api/mailer ReferenceBatch model GuideMailer Entity
Mailer in Postman

About mailer

The mailer sends every email the platform makes: password resets, form autoresponders, emails from jobs. A batch is one send, with its subject, sender, template and counts of opens and clicks. Its emails are the messages to each recipient, with their status.

Writes No

The API reads batches and emails; sending happens through forms, jobs and the platform itself.

Mailer Entity

List email batches#

GET /cdna-api/mailer/batches

Lists email batches. Without limit every match comes back.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
Batch, in the Reference

Parameters

propertiesquery
selector
The fields and relations to return, such as {id,subject,sendAt}.
filtersquery
name=value
Any stored field, or a relation with a dot, such as parent.id=12. Prefix the name with !, >, <, % or |. Use stored field names exactly as in the model, and compare totalCount with the unfiltered list's to confirm a filter applied.
orderByquery
string
field:ASC or field:DESC, comma-separated. Stored fields only.
limitquery
integer
Records per response. There is no default.
offsetquery
integer
Records to skip.

Example

List email batches 
GET /cdna-api/mailer/batches?limit=2&properties={id,subject,sendAt} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "totalCount": 22,
  "data": [
    {
      "id": 1,
      "subject": "Core dna: Password Reset",
      "sendAt": "2019-09-24T13:40:38+00:00"
    },
    {
      "id": 2,
      "subject": "Core dna: Password Reset",
      "sendAt": "2019-11-15T07:11:41+00:00"
    }
  ]
}
Open in Postman docs Real response from this documentation site

List the emails in a batch#

GET /cdna-api/mailer/emails/{batch.id}

Lists the emails sent in one batch, one per recipient.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
Email, in the Reference

Parameters

batch.idpathrequired
integer
The batch id.
propertiesquery
selector
The fields and relations to return, such as {id,status,sent}.
filtersquery
name=value
Any stored field, or a relation with a dot, such as parent.id=12. Prefix the name with !, >, <, % or |. Use stored field names exactly as in the model, and compare totalCount with the unfiltered list's to confirm a filter applied.
orderByquery
string
field:ASC or field:DESC, comma-separated. Stored fields only.
limitquery
integer
Records per response. There is no default.
offsetquery
integer
Records to skip.

Example

List the emails in a batch 
GET /cdna-api/mailer/emails/1?limit=2&properties={id,status,sent} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "status": "queued",
      "sent": null
    }
  ]
}
Open in Postman docs Real response from this documentation site