Skip to content

Retrieving a preview for a Mailing Synchronization

GET /integrations/inxmail-professional/mailing-synchronizations/{id}/preview

Request Parameters

Parameter Required In Description
id yes path The ID of the mailing synchronization
kind no query Default: latest
  • latest: retrieves a preview for the latest version of a mailing
  • draft: retrieves the preview for the mailing draft
  • lastApproved: retrieves the preview for the approved mailing
testProfileId no query The preview can be personalized using test profiles from Inxmail Professional which can be collected via GET /mailing-synchronizations/{id}/test-profiles

Response Structure

Path Type Description
htmlContent String html part of the mailing
textContent String text part of the mailing
subject String subject of the mailing

Basic example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/0b405924-a96a-4c52-a20e-488d554f518a/preview/' -i -X GET \
    -H 'Authorization: Basic <base64Encoded user:password>'

Response:

{
    "htmlContent": "<!DOCTYPE html PUBLIC....",
    "textContent": "test....",
    "subject": "New Mailing",
    "_links": {
        "self": {
            "href": "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/e12da055-9d95-4287-a13c-a329d9898d09/preview{?testProfileId,kind}",
            "templated": true
        }
    }
}
Back to top