Skip to content

Retrieving a list of Mailing Synchronizations

GET /integrations/inxmail-professional/mailing-synchronizations/

Request Parameters

Parameter Required In Description
syncModifications no query See chapter Synchronize Resources Efficiently
syncToken no query See chapter Synchronize Resources Efficiently
mailingId no query Returns mailing-synchronizations for a list of comma-separated New Xperience mailing IDs.
readyForSending no query Returns all mailing-synchronizations with an approved mailing
mailingHasDraft no query Returns all mailing-synchronizations with a draft mailing
mailingIsApproved no query Returns all mailing-synchronizations with an approved mailing
sortBy no query Sorts mailing-synchronizations by either creationDate, modificationDate or mailingName. Cannot be used in conjunction with syncModifications. Default: by date of creation, may vary from creationDate, though
order no query Orders mailing-synchronizations asc (ascending) or desc (descending). Cannot be used in conjunction with syncModifications. Default: asc
pageSize no query Specifies the number of results per page. Default: 1000

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 (of the latest version)
approvedMailingName String The name of the New Xperience mailing (of the approved version)
readyForSending Boolean Indicates if the mailing can be sent
mailingHasDraft Boolean Indicates if there exists a draft version for this mailing in New Xperience
mailingIsApproved Boolean Indicates if there exists an approved version for this mailing in New Xperience
target Object The information about the upload 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.

Basic Example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/' -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: ...

{
    "_embedded": {
        "inx:mailing-synchronizations": [
            {
                "id": "1b2028f4-8319-4492-9151-22c76844a084",
                "mailingId": "ad11d3b4-f741-4be4-b5f8-ea613c2dac3c",
                "mailingName": "test12356",
                "approvedMailingName": "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/mrm/integrations/mailings/ad11d3b4-f741-4be4-b5f8-ea613c2dac3c/edit"
                    }
                }
            },
            {
                "id": "fd3f9e99-fcd9-49cc-be5a-db33885ff748",
                "mailingId": "ec787288-9391-4bd8-9b9b-2561fc28e746",
                "mailingName": "Newsletter issue 13",
                "approvedMailingName": "Newsletter issue 12",
                "creationDate": "2021-02-10T09:26:50.732Z",
                "readyForSending": true,
                "mailingHasDraft": true,
                "mailingIsApproved": true,
                "modificationDate": "2021-02-23T13:30:20.037Z",
                "target": {
                    "customer": "mrm",
                    "listId": 6,
                    "listName": "New Xperience Adapter - Staging"
                },
                "mailingUploadsModificationDate": "2021-02-23T13:30:20.037Z",
                "sendingsModificationDate": "2021-02-23T13:30:20.037Z",
                "_links": {
                    "self": {
                        "href": "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/fd3f9e99-fcd9-49cc-be5a-db33885ff748"
                    },
                    "inx:mailing-editor": {
                        "href": "https://myka-1.my.inxmail.de/mrm/integrations/mailings/ec787288-9391-4bd8-9b9b-2561fc28e746/edit"
                    }
                }
            },
            {
                "id": "81d9a5b0-f67c-441d-91a9-d9dd06515961",
                "mailingId": "3a1caafe-27bc-4e1a-92de-e5f38e1767c0",
                "mailingName": "New Mailing",
                "approvedMailingName": null,
                "creationDate": "2021-02-10T09:26:59.711Z",
                "readyForSending": false,
                "mailingHasDraft": true,
                "mailingIsApproved": false,
                "modificationDate": null,
                "target": {
                    "customer": "mrm",
                    "listId": 6,
                    "listName": "New Xperience Adapter - Staging"
                },
                "_links": {
                    "self": {
                        "href": "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/81d9a5b0-f67c-441d-91a9-d9dd06515961"
                    },
                    "inx:mailing-editor": {
                        "href": "https://myka-1.my.inxmail.de/mrm/integrations/mailings/3a1caafe-27bc-4e1a-92de-e5f38e1767c0/edit"
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations"
        },
        "next": {
            "href": "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations?cursor=eyJhZnRlcklkIjo4NTZ9"
        },
        "curies": [
            {
                "href": "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
                "name": "inx",
                "templated": true
            }
        ]
    }
}