Skip to content

Retrieving a Mailing

GET /mailings/{id}

Request Parameters

Parameter Required In Description
id yes path The ID of the Mailing

Response Structure

Path Type Description
id String The ID of the Mailing instance
Name Description
inx:mailing-editor The link to open the New Xperience Mailing Editor for the Mailing

Basic Example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/mailings/cb6341d8-e44b-4586-a383-d02e7db5b873' -i -X GET \
    -H 'Authorization: Basic <base64Encoded user:password>'

Response:

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...

{
    "id": "cb6341d8-e44b-4586-a383-d02e7db5b873",
    "_links": {
        "self": {
            "href": "http://myka-1.my-api.inxmail.de/mailings/cb6341d8-e44b-4586-a383-d02e7db5b873"
        },
        "inx:mailing-editor": {
            "href": "http://myka-1.my-api.inxmail.de/editor/integrations/mailings/cb6341d8-e44b-4586-a383-d02e7db5b873/edit"
        },
        "curies": [
            {
                "href": "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
                "name": "inx",
                "templated": true
            }
        ]
    }
}
Back to top