NGngpvan

/email/message/{emailId}

Changed on

Use this endpoint to retrieve information about a specific Email available in the current context.

get/email/message/{emailId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/email/message/{emailId}
  • Auth
    HTTP basic

Path parameters

emailIdstring required

String identifier for a specific Email, corresponds to ForeignMessageId from email messages.

Query parameters

$expandstring

Optional; comma-delimited list of expansion properties: emailMessageContent, EmailMessageContentDistributions

Response

200

foreignMessageIdstring
namestring
createdBystring
dateCreatedstring
dateScheduledstring
campaignIDinteger
dateModifiedstring

Example response

{
  "foreignMessageId": "K3Jy8GbLEeuYiQAVXUPJkg2",
  "name": "Tom Nook Email",
  "createdBy": "Max Kamin-Cross",
  "dateCreated": "2021-02-04T04:27:00Z",
  "dateScheduled": "2021-02-04T04:29:00Z",
  "campaignID": 725,
  "dateModified": "2021-02-04T04:29:21.653Z",
  "emailMessageContent": [
    {
      "name": "Tom Nook Email",
      "senderDisplayName": "Deserted Island Getaway Package",
      "senderEmailAddress": "nook@nook.inc",
      "createdBy": "Max Kamin-Cross",
      "dateCreated": "2021-02-04T04:29:00Z",
      "emailMessageContentDistributions": {
        "dateSent": "2021-02-04T04:29:00Z",
        "recipientCount": 1,
        "bounceCount": 1
      }
    }
  ]
}

Changes