Skip to content

Create a Mailing

POST /mailings

Creates a new Mailing based on an already existing and approved Mailing Template, which can be edited using the New Xperience Mailing Editor.

Request Parameters

Parameter Required In Description
mailingTemplateId yes query The ID of the approved Mailing Template based on which the new Mailing instance should be created

Payload Structure

Path Type Description Constraints
name String Sets the initial name of the Mailing
  • Must not be null
  • Must not be empty
  • Must contain at least one non-whitespace character

Response Structure

Path Type Description
id String The ID of the created Mailing instance
Name Description
inx:mailing-editor The link to open the New Xperience Mailing Editor for the Mailing

Basic Example


$ curl '' -i -X POST \
    -H 'Authorization: Basic <base64Encoded user:password>' \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "name" : "My first Mailing based on a Mailing Template"


HTTP/1.1 201 Created
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...

    "id": "a7968193-10ca-49fb-b088-72aff812a205",
    "_links": {
        "self": {
            "href": ""
        "inx:mailing-editor": {
            "href": ""
        "curies": [
                "href": "{rel}",
                "name": "inx",
                "templated": true