Sequences

Archive sequence

Changed on

Archives a sequence and stops new enrollments.

post/sequences/{sequenceId}/archive

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sequences/{sequenceId}/archive
  • Auth
    HTTP bearer

Path parameters

sequenceIdstring required

Response

Sequence archived successfully

successboolean

Example response

{
  "sequence": {
    "id": "seq_abc123",
    "name": "Welcome Sequence",
    "trigger": "trigger_list",
    "sendingWindow": {
      "enabled": true,
      "timezone": "Europe/Kiev",
      "startTime": "08:00",
      "endTime": "20:00",
      "days": [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday"
      ]
    },
    "frequencyCapEnabled": true,
    "keyDates": {
      "timezone": "America/New_York",
      "dates": [
        {
          "key": "black_friday_starts",
          "label": "Black Friday starts",
          "at": "2026-11-27T05:00:00.000Z"
        }
      ]
    },
    "audienceAutoEnroll": {
      "enabled": true,
      "audience": {
        "type": "lists",
        "listIds": [
          "list_abc123"
        ],
        "segmentId": "seg_abc123",
        "includedSubscriberIds": [
          "sub_abc123",
          "sub_def456"
        ]
      }
    },
    "bccEmails": [
      "cs-team@example.com"
    ]
  }
}

Changes

  • 75ac3f76f3c3Revision changes
    • info

      added the optional property / to the response with the status

  • 66405b8b1acaRevision changes
    • info

      added the optional property //////// to the response with the status