Sequences

Create a sequence

Creates a sequence in the authenticated workspace.

post/v1/sequences

Request

  • Base URL: https://api.mailrith.com
  • URL: https://api.mailrith.com/v1/sequences
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.

Request body

namestring required
connection_idstring nullable
reply_to_emailstring nullable
track_opensboolean
track_clicksboolean
utm_sourcestring nullable
utm_mediumstring nullable
utm_campaignstring nullable
utm_termstring nullable
utm_contentstring nullable

Example request

{
  "definition": {
    "emails": [
      {
        "id": "welcome",
        "subject": "Welcome",
        "previewText": "Thanks for joining",
        "bodyDocument": {
          "type": "doc",
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Welcome to the newsletter."
                }
              ]
            }
          ]
        },
        "status": "Published",
        "delayValue": 0,
        "delayUnit": "day",
        "sendOnWeekdays": [
          "Mon",
          "Tue",
          "Wed",
          "Thu",
          "Fri"
        ],
        "audienceMode": "all",
        "audienceDefinition": null
      }
    ]
  }
}

Response

Sequence created

Example response

{
  "data": {
    "definition": {
      "emails": [
        {
          "id": "welcome",
          "subject": "Welcome",
          "previewText": "Thanks for joining",
          "bodyDocument": {
            "type": "doc",
            "content": [
              {
                "type": "paragraph",
                "content": [
                  {
                    "type": "text",
                    "text": "Welcome to the newsletter."
                  }
                ]
              }
            ]
          },
          "status": "Published",
          "delayValue": 0,
          "delayUnit": "day",
          "sendOnWeekdays": [
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri"
          ],
          "audienceMode": "all",
          "audienceDefinition": null
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.