Skip to content

Retrieving a single Mailing Synchronization

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

Request Parameters

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

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 synchronization instance was last modified
mailingId String The ID of the New Xperience mailing created for using the mailing editor.
mailingName String The name of the New Xperience mailing
readyForSending Boolean Indicates whether the mailing can be sent
mailingHasDraft Boolean Indicates whether there exists a draft version for this mailing in New Xperience
mailingIsApproved Boolean Indicates whether there exists an approved version for this mailing in New Xperience
target Object The information about the synchronization target
target.customer String The alias of the associated inxmail professional customer instance.
target.listId Number The ID of the list the uploaded mailing resides in
target.listName String The name of the list the uploaded mailing resides in
mailingUploadsModificationDate String The date and time when a mailing upload for this synchronization was created or updated. Value is null until the first mailing upload is created.
sendingsModificationDate String The date and time when a sending for this synchronization was created. Value is null until the first sending is created.
_links Object The links currently available for this resource.
Name Description
inx:mailing-editor The link to open the mailing editor for the mailing.
inx:mailing-preview-draft The link to open the draft version of the mailing.
inx:mailing-preview-approved The link to open the approved version of the mailing.
inx:sendings The link to retrieve the sendings.
inx:mailing-uploads The link to retrieve the mailing-uploads.

Basic Example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/1b2028f4-8319-4492-9151-22c76844a084' -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": "1b2028f4-8319-4492-9151-22c76844a084",
    "mailingId": "ad11d3b4-f741-4be4-b5f8-ea613c2dac3c",
    "mailingName": "test12356",
    "creationDate": "2021-02-10T09:09:24.140Z",
    "readyForSending": true,
    "mailingHasDraft": false,
    "mailingIsApproved": true,
    "modificationDate": "2021-02-23T10:43:09.802Z",
    "target": {
        "customer": "mrm",
        "listId": 6,
        "listName": "New Xperience Adapter - Staging"
    },
    "mailingUploadsModificationDate": "2021-02-23T10:43:09.802Z",
    "sendingsModificationDate": "2021-02-23T10:43:09.802Z",
    "_links": {
        "self": {
            "href": "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/1b2028f4-8319-4492-9151-22c76844a084"
        },
        "inx:mailing-editor": {
            "href": "https://myka-1.my.inxmail.de/editor/integrations/mailings/ad11d3b4-f741-4be4-b5f8-ea613c2dac3c/edit"
        },
        "inx:mailing-preview-draft": {
            "href": "https://dmyka-1.my.inxmail.de/editor/integrations/mailings/ed175a8d-1416-45d4-886d-e37a2135ea23/preview/draft"
        },
        "inx:mailing-preview-approved": {
            "href": "https://dmyka-1.my.inxmail.de/editor/integrations/mailings/ed175a8d-1416-45d4-886d-e37a2135ea23/preview/approved"
        },
        "inx:sendings": {
            "href": "https://dmyka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/a955fd76-f48f-4612-b82a-8180f234b5a1/sendings"
        },
        "inx:mailing-uploads": {
            "href": "https://dmyka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/a955fd76-f48f-4612-b82a-8180f234b5a1/mailing-uploads/latest"
        },
        "curies": [
            {
                "href": "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
                "name": "inx",
                "templated": true
            }
        ]
    }
}