MailcrateDocs
Deliveries

Get a delivery

GET
/public/delivery/{id}

Requires the delivery:read scope.

Authorization

ApiKey
headerAuthorization<token>

Api-Key mc_... — a workspace API key.

Path Parameters

id*string

Response Body

application/json
  1. response
id*string
status*string
subject*string
toAddresses*string
contactId?string
campaignRecipientKey*string|null
externalReferenceId*string|null
lane?string
suppressionReason?string|null
isTest?boolean
renderedHTML?string
fromName?string
fromAddress?string
cc?string|null
bcc?string|null
replyTo?string|null
preHeaderText?string|null
messageIdHeader?string|null
sendAttemptedAt?|
Formatdate-time
data?
templateData?|null
emailTemplateId?string|null
emailTemplateName?string|null
emailTemplateDeleted?boolean
campaignId?string|null
campaignName?string|null
campaignDeleted?boolean
transactionalMessageId?string|null
transactionalMessageName?string|null
transactionalMessageDeleted?boolean
attachments?array<>
created*string
Formatdate-time
updated*string
Formatdate-time
Example Request
curl -X GET 'https://api.mailcrate.io/public/delivery/string' \  -H 'Authorization: Api-Key <api_key>'
Example Response
{  "id": "string",  "status": "string",  "subject": "string",  "toAddresses": "string",  "contactId": "string",  "campaignRecipientKey": "string",  "externalReferenceId": "string",  "lane": "string",  "suppressionReason": "string",  "isTest": true,  "renderedHTML": "string",  "fromName": "string",  "fromAddress": "string",  "cc": "string",  "bcc": "string",  "replyTo": "string",  "preHeaderText": "string",  "messageIdHeader": "string",  "sendAttemptedAt": "2019-08-24T14:15:22Z",  "data": {},  "templateData": {},  "emailTemplateId": "string",  "emailTemplateName": "string",  "emailTemplateDeleted": true,  "campaignId": "string",  "campaignName": "string",  "campaignDeleted": true,  "transactionalMessageId": "string",  "transactionalMessageName": "string",  "transactionalMessageDeleted": true,  "attachments": [    {      "id": "string",      "filename": "string",      "contentType": "string",      "size": 0    }  ],  "created": "2019-08-24T14:15:22Z",  "updated": "2019-08-24T14:15:22Z"}

Update a contact PUT

Requires the `contact:write` scope.

Get delivery stats GET

Requires the `delivery:read` scope.