Skip to content

Create a sending

POST /integrations/inxmail-professional/mailing-synchronizations/{id}/sendings

This request only returns successfully if the whole setup for the sending was successful. It will not block until the sending is completed, though, a successful response code is no guarantee that the mailing was actually sent.

After this request returned successfully, the following tasks will be executed in Inxmail Professional:

  • A mailing with all content of the approved NXP mailing is created in the according list in Inxmail Professional.
  • The mailing in Inxmail Professional will be approved.
  • The mailing in Inxmail professional will be sent or scheduled for sending.

This requests only returns successfully if the whole setup for the sending was successful.

Note

The Mailing in NXP must be approved prior to create a sending. Whether the mailing is approved, is indicated by the readyForSending flag in /mailing-synchronizations

Request Parameters

Parameter Required In Description
id yes path The ID of the Mailing Synchronization the sending shall be created for

Payload Structure

Path Type Description Constraints
scheduleDate Date with time Optional: if not defined the mailing will be sent immediately
  • Date and time values are always exchanged in ISO 8601 format with time zone information being mandatory

Response Structure

Path Type Description
id String The ID of the sending instance
creationDate String The date and time when the sending instance was created
mailingId String The ID of the NXP mailing created for using the mailing editor.
target Object The information about the sending target
target.mailingId Number The ID of the mailing in Inxmail Professional
target.sendingId Number The ID of the sending in Inxmail Professional
_links Object The links currently available for this resource.
Name Description
inx:report The link to open the report for the sending.

Basic example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/0b405924-a96a-4c52-a20e-488d554f518a/sendings' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Basic <base64Encoded user:password>' \
    -d '{
}'

Response:

HTTP/1.1 201 Created
Location: https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/0b405924-a96a-4c52-a20e-488d554f518a/sendings/4379124b-be62-4018-86fa-92b98497d299
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...

{
    "id": "536eb5a9-8e95-4f35-b0dd-21f901af0679",
    "creationDate": "2021-02-10T09:49:11.051Z",
    "target": {
        "mailingId": 836,
        "sendingId": 24
    },
    "_links": {
        "self": {
            "href": "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/mailing-synchronizations/e12da055-9d95-4287-a13c-a329d9898d09/sendings/536eb5a9-8e95-4f35-b0dd-21f901af0679"
        },
        "inx:report": {
            "href": "https://myka-1.my.inxmail.de/reporting/reports/e12da055-9d95-4287-a13c-a329d9898d09"
        },
        "curies": [
            {
                "href": "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
                "name": "inx",
                "templated": true
            }
        ]
    }
}