Sequences

Update a sequence

Updates an existing paused Sequence. Before changing a running Sequence, read it by ID, retain its status in the current task only, pause it, apply the update, and use bounded direct item reads until is_updating is false. Run preflight, return it to running only if it was running before and preflight passes, and verify the final status. If the update fails before changing the Sequence, restore its prior running status when preflight passes. If readiness or the prior status cannot be restored, leave it paused and immediately report the failure; never activate a Sequence that was not already running.

put/v1/sequences/{sequence_id}

Request

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

Path parameters

sequence_idstring required

The sequence identifier.

Request body

namestring
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

Successful response

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.