Sequences

Activate or pause a sequence

Starts or pauses one Sequence without changing its content or delivery settings.

put/v1/sequences/{sequence_id}/status

Request

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

Path parameters

sequence_idstring required

The Sequence identifier.

Request body

status'running' | 'paused' required

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.