Contents x
    /message/getHistorical
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    /message/getHistorical

    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /message/getHistorical

    Make sure the "datastore_rmo" feature switch is on. In case of trouble contact Support.

    Fetch a specific (group) message as it was sent to a defined contact, including resolved personalizations.

    Query parameters
    messageId
    integer (int64) Required

    ID of the (sent) message to fetch.

    contactId
    integer (int64) Required

    ID of the contact for whom the message shall be personalized.

    Responses
    200
    Expand All
    object
    contactId
    integer (int64)
    messageId
    integer (int64)
    name
    string
    externalId
    string
    description
    string
    messageCategoryId
    integer (int64)
    processingDate
    string
    type
    object (MessageBase)
    subject
    string
    emailBodyText
    string
    emailBodyHtml
    string
    smsText
    string
    faxText
    string
    emailHeaders
    Array of object (Attribute)
    object
    name
    string
    value
    string
    attachments
    Array of object (Attachment)
    object
    name
    string
    contentType
    string
    content
    string
    attachmentReferences
    Array of object (AttachmentReference)
    object
    contentId
    string
    reference
    string
    encoding
    string
    encodingSMS
    string
    imageHandlingMode
    string
    currentDataPopulatedToHistorical
    boolean
    Defaultfalse
    400

    Missing parameter (messageId/contactId) or parameter value, for example:

    {
      "errorActor": "CLIENT",
      "errorCode": "MISSING_PARAMETER",
      "message": "Parameter 'messageId' is mandatory but no value was specified.",
      "parameterName": "messageId",
      "propertyName": null,
      "value": "null"
    }


    Message ID / ContactId does not exist, for example:

    {
      "errorActor": "CLIENT",
      "errorCode": "NO_SUCH_OBJECT",
      "message": "Message with id=24011454555 does not exist.",
      "objectType": "Message",
      "propertyName": "id",
      "propertyValue": "24011454555"
    }

    Was this article helpful?
    What's Next