Create a Mailing Synchronization¶
POST /integrations/inxmail-professional/mailing-synchronizations
Creates a new mailing synchronization based on an already existing New Xperience mailing when the mailingId
parameter is given. Conversely, it will create a new mailing which can be edited using the New Xperience mailing editor with placeholders, text modules and target groups of the target customer and list.
After this request returned successfully, the following tasks will be executed for the new mailing editor:
- The attributes, text modules and target groups which are available in context of the specified customer and list are provided to the new mailing editor.
- A new New Xperience mailing editor mailing is created and associated with the list of available attributes and text modules.This is the mailing which will be uploaded to inxmail professional when you create a sending. This requests only returns successfully if the whole setup for a mailing synchronization was successful.
Payload Structure¶
Path | Type | Description | Constraints |
---|---|---|---|
customer | String | The Inxmail Professional customer to create the synchronization for |
|
listId | Number | The id of the Inxmail Professional list to create the synchronization for (gets all recipient attributes and textmodules of this list available in New Xperience) |
|
mailingName | String | Optional: Sets the initial name of a mailing |
|
mailingId | String | Optional: An existing New Xperience mailing which shall be synchronized | |
templateMailingId | String | Optional: An existing New Xperience mailing which shall be used as a template (creates a copy of this mailing) |
Note
It is not possible to specify both, the mailingId and the templateMailingId parameter in a single request as they are mutually exclusive.
Response Structure¶
Path | Type | Description |
---|---|---|
id | String | The ID of the mailing synchronization instance |
creationDate | String | The date and time when the mailing synchronization 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 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 associated New Xperience mailing resides in |
target.listName | String | The name of the list the associated New Xperience 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. |
Links¶
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 POST \
-H 'Authorization: Basic <base64Encoded user:password>' \
-H 'Content-Type: application/hal+json' \
-d '{
"customer" : "mrm",
"listId" : 6,
"mailingName" : "My first Mailing"
}'
Response:
HTTP/1.1 201 Created
Location: https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/0b405924-a96a-4c52-a20e-488d554f518a
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...
{
"id": "7dbddfcb-578c-438a-bba9-1ea777b4154f",
"mailingId": "bfc4463b-e436-46c7-83c4-1280a0f5464e",
"mailingName": "My first Mailing",
"creationDate": "2021-02-23T11:14:46.034Z",
"readyForSending": false,
"mailingHasDraft": true,
"mailingIsApproved": false,
"modificationDate": "2021-02-23T11:14:46.034Z",
"target": {
"customer": "myka",
"listId": 6,
"listName": "New Xperience Adapter - Staging"
},
"mailingUploadsModificationDate": "2021-02-23T11:14:46.034Z",
"sendingsModificationDate": "2021-02-23T11:14:46.034Z",
"_links": {
"self": {
"href": "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/7dbddfcb-578c-438a-bba9-1ea777b4154f"
},
"inx:mailing-editor": {
"href": "https://myka-1.my.inxmail.de/mrm/integrations/mailings/bfc4463b-e436-46c7-83c4-1280a0f5464e/edit"
},
"curies": [
{
"href": "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
"name": "inx",
"templated": true
}
]
}
}