Mailing

A representation of a platform-related email.

bodyHtml
string

The mailing's custom email body, represented in HTML. If provided this field will override any associated template.

bodyText
string

The plain-text representation of the 'bodyHTML' field.

bouncedAt
string <date-time>

The date and time the email was bounced.

clickCount
integer

The total number of times links within the email were clicked (if the message is tracking links).

clickedAt
string <date-time>

The most recent date and time a link was clicked (if the message is tracking links).

createdAt
string <date-time>

The date and time the mailing was created.

deliveredAt
string <date-time>

The date and time the email was delivered.

errorBacktrace
string

Technical details explaining the mailing's error.

errorReason
string <= 255 characters

A summary explaining the mailing's error.

followUpTaskScheduledAt
string <date-time>

The date and time of when a follow-up task should be due for this mailing.

followUpTaskType
string <= 255 characters

The type of follow-up task to create. Possible values are 'follow_up' or 'no_reply'.

mailboxAddress
string

The email address the mailing was sent from.

mailingType
string <= 255 characters

A description of the type of the emailing (e.g. "sequence", "single", "campaign").

markedAsSpamAt
string <date-time>

The date and time the email was marked as spam.

messageId
string <= 255 characters

The MIME content Message-ID of the delivered message.

notifyThreadCondition
string <= 255 characters

The condition of when to bump this mailing to the top of the user's inbox. Possible values are 'always' or 'no_reply'.

notifyThreadScheduledAt
string <date-time>

The date and time of when this mailing should be bumped to the top of the user's inbox.

notifyThreadStatus
string <= 255 characters

The status of the bump. Possible values are 'pending', 'sent' or 'skipped'.

openCount
integer

The total number of times the email was opened (if the message is tracking opens).

openedAt
string <date-time>

The most recent date and time the email was opened (if the message is tracking opens).

overrideSafetySettings
boolean

A boolean value whether users can override submission if template variables have not all been replaced.

references
Array of strings

A list of references for the mailing taken from the email header.

repliedAt
string <date-time>

The date and time the email was replied to.

retryAt
string <date-time>

The date and time the email will rety to send.

retryCount
integer

The number of times the email has been retried to send.

retryInterval
integer

The amount of time in seconds between retry attempts.

scheduledAt
string <date-time>

The date and time the email is scheduled to send.

state
string <= 255 characters

The current state of the mailing. Can be 'bounced', 'delivered', 'delivering', 'drafted', 'failed', 'opened', 'placeholder', 'queued', 'replied', or 'scheduled'.

stateChangedAt
string <date-time>

The date and time the state last changed.

subject
string

The subject line of the email.

trackLinks
boolean

A boolean value whether the mailing is tracking link clicks.

trackOpens
boolean

A boolean value whether the mailing is tracking email opens.

unsubscribedAt
string <date-time>

The date and time the recepient unsubscribed from the mailing's sequence.

updatedAt
string <date-time>

The date and time the mailing was last updated.

{
  • "bodyHtml": "string",
  • "bodyText": "string",
  • "bouncedAt": "2019-08-24T14:15:22Z",
  • "clickCount": 0,
  • "clickedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deliveredAt": "2019-08-24T14:15:22Z",
  • "errorBacktrace": "string",
  • "errorReason": "string",
  • "followUpTaskScheduledAt": "2019-08-24T14:15:22Z",
  • "followUpTaskType": "string",
  • "mailboxAddress": "string",
  • "mailingType": "string",
  • "markedAsSpamAt": "2019-08-24T14:15:22Z",
  • "messageId": "string",
  • "notifyThreadCondition": "string",
  • "notifyThreadScheduledAt": "2019-08-24T14:15:22Z",
  • "notifyThreadStatus": "string",
  • "openCount": 0,
  • "openedAt": "2019-08-24T14:15:22Z",
  • "overrideSafetySettings": true,
  • "references": [
    ],
  • "repliedAt": "2019-08-24T14:15:22Z",
  • "retryAt": "2019-08-24T14:15:22Z",
  • "retryCount": 0,
  • "retryInterval": 0,
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "stateChangedAt": "2019-08-24T14:15:22Z",
  • "subject": "string",
  • "trackLinks": true,
  • "trackOpens": true,
  • "unsubscribedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Mailing Relationships

data (object) or links (object) (sequence)

The followup sequence associated with this mailing. You can use only the attribute id to filter mailings by followUpSequence (e.g. filter[followUpSequence][id]=X).

data (object) or links (object) (mailbox)

The mailbox associated with this mailing. You can use only the attribute id to filter mailings by mailbox (e.g. filter[mailbox][id]=X).

data (object) or links (object) (opportunity)

The associated opportunity. You can use only the attribute id to filter mailings by opportunity (e.g. filter[opportunity][id]=X).

data (object) or links (object) (prospect)

The prospect associated with this mailing. You can use only the attribute id to filter mailings by prospect (e.g. filter[prospect][id]=X).

Array of data (object) or links (object) (recipient)

Recipients of the mailing. Relationship recipients cannot be used as a filter.

data (object) or links (object) (sequence)

The associated sequence. You can use only the attribute id to filter mailings by sequence (e.g. filter[sequence][id]=X).

data (object) or links (object) (sequenceState)

The associated sequence state. You can use only the attribute id to filter mailings by sequenceState (e.g. filter[sequenceState][id]=X).

data (object) or links (object) (sequenceStep)

The associated sequence step. You can use only the attribute id to filter mailings by sequenceStep (e.g. filter[sequenceStep][id]=X).

data (object) or links (object) (task)

The task this mailing will or did complete upon sending. You can use only the attribute id to filter mailings by task (e.g. filter[task][id]=X).

Array of data (object) or links (object) (task)

All tasks associated with this mailing, such as a follow-up task. Relationship tasks cannot be used as a filter.

data (object) or links (object) (template)

The template associated with this mailing. You can use only the attribute id to filter mailings by template (e.g. filter[template][id]=X).

data (object) or links (object) (user)

The user associated with this mailing. You can use only the attribute id to filter mailings by user (e.g. filter[user][id]=X).

{
  • "followUpSequence": {
    },
  • "mailbox": {
    },
  • "opportunity": {
    },
  • "prospect": {
    },
  • "recipients": [
    ],
  • "sequence": {
    },
  • "sequenceState": {
    },
  • "sequenceStep": {
    },
  • "task": {
    },
  • "tasks": [
    ],
  • "template": {
    },
  • "user": {
    }
}

Mailing Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given Mailing has to external sources. provideDataConnections

⌵ Mailing Actions

Get a Collection of Mailings

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/mailings
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Mailing
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/mailings
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Get a Mailing by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/mailings/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}