Create a sending¶

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

This request initiates a sending. It will not block until the sending is completed, so a successful response code is no guarantee that the mailing was actually sent.

The request will perform the following tasks in Inxmail Professional:

• A mailing with all content of the approved New Xperience 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.

The exact behavior of this endpoint depends on whether a transaction ID is provided. If no transaction ID is provided, the request will only return successfully if the whole setup for the sending was successful. The only possible state of a sending in this case is CREATED. An error response is no guarantee that the mailing wasn't sent. A request without a transaction ID can't safely be retried.

A transaction ID serves as a unique identifier for the sending to provide idempotency. The transaction ID must be unique in the scope of the mailing synchronization.

If a transaction ID is provided, the endpoint will behave as follows:

• If the whole setup for the sending was successful, the endpoint will respond with a 201 Created.
• If the sending is retried with the same transaction ID or there was a server-side error, the endpoint will respond with 200 OK, yielding the regular response body including a state field indicating the current status.
• If there was a client-side error, the endpoint will respond with an error response in the 4xx range.
• If the request couldn't be processed at all, the endpoint will respond with a 500 Internal Server Error.

If you do not receive any response or a 5xx response, retry the request with the same transaction ID to check the outcome.

In the case of a 200 OK response, inspect the state field to derive the next action:

• PENDING means the request is still being processed. Retry the request with the same transaction ID to check the outcome.
• CREATED means the mailing was successfully sent or scheduled for sending, no further action is required.
• FAILED means the sending definitively failed. Retry the request with a different transaction ID to try again.
• INDETERMINATE_FAILURE means it's uncertain whether the sending went out successfully or not. It is not safe to retry the request. Contact the Inxmail support team for further assistance.

Retries should be performed with a backoff. Sendings with state PENDING should be retried for a total of 5 minutes. Sendings with state FAILED should be recreated with a different transaction ID for at most three times for a total of 15 minutes. If the sending does not reach the CREATED state after these retries, contact the Inxmail support team for further assistance in either case.

A retry with the same transaction ID must use the exact same request payload. Any properties differing from a previously created sending will be ignored.

Request Parameters¶

Payload Structure¶

Response Structure¶

Links¶

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",
    "mailingSynchronizationId": "0b405924-a96a-4c52-a20e-488d554f518a",
    "creationDate": "2021-02-10T09:49:11.051Z",
    "scheduleDate": null,
    "state": "CREATED",
    "transactionId": null,
    "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
            }
        ]
    }
}