Skip to content

Retrieving a mailing-upload for a Mailing Synchronization

GET /integrations/inxmail-professional/mailing-synchronizations/{syncId}/mailing-upload/{id|latest}

Request Parameters

Parameter Required In Description
id yes path The ID of the mailing-upload the information should be retrieved for.
latest no path Instead of using a mailing-upload ID, use latest to get the mailing-upload with the most recent changes
syncId yes path The ID of the Mailing Synchronization the mailing-upload should be retrieved for

Response Structure

Path Type Description
id String The ID of the mailing-upload instance
creationDate String The date and time when the mailing-upload instance was created
modificationDate String The date and time when the mailing-upload instance was last modified
target Object The information about the mailing-upload target
target.mailingId Number The ID of the mailing in Inxmail Professional
_links Object The links currently available for this resource.
Name Description

Basic example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/0b405924-a96a-4c52-a20e-488d554f518a/mailing-uploads/f992c6a4-dffa-4e33-baad-7f1206371166' -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": "f992c6a4-dffa-4e33-baad-7f1206371166",
    "creationDate": "2021-05-11T12:58:48.260Z",
    "modificationDate": "2021-05-11T12:58:48.260Z",
    "target": {
        "mailingId": 1672
    },
    "_links": {
        "self": {
            "href": "https://inxmail-mrm-1.my-api.inxstaging.de/integrations/inxmail-professional/mailing-synchronizations/be518b09-fa9f-40d5-8312-3a8f40db891b/mailing-uploads/f992c6a4-dffa-4e33-baad-7f1206371166"
        },
        "curies": [
            {
                "href": "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
                "name": "inx",
                "templated": true
            }
        ]
    }
}
Back to top