Sequences

Cancel an audience enrollment run

Changed on

Cancels a queued run immediately or asks a running run to stop after the batch it is currently enrolling. Contacts already enrolled stay in the sequence.

post/sequences/{sequenceId}/audience-enrollments/{runId}/cancel

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sequences/{sequenceId}/audience-enrollments/{runId}/cancel
  • Auth
    HTTP bearer

Path parameters

sequenceIdstring required

Sequence ID.

runIdstring required

Audience enrollment run ID.

Response

Cancelled or stopping

successboolean
messagestring

Example response

{
  "success": true,
  "audienceEnrollment": {
    "id": "aer_abc123",
    "sequenceId": "seq_abc123",
    "status": "running",
    "audience": {
      "type": "lists",
      "listIds": [
        "list_abc123"
      ],
      "segmentId": "seg_abc123",
      "includedSubscriberIds": [
        "sub_abc123",
        "sub_def456"
      ]
    },
    "data": {
      "sale_ends_at": "2026-11-29T23:59:00Z",
      "discount_percent": 20
    },
    "targetNodeId": "node_delay_1",
    "estimatedCount": 12000,
    "processedCount": 4000,
    "enrolledCount": 3800,
    "skippedCount": 200,
    "source": "api"
  }
}

Changes

  • 66405b8b1acaRevision changes
    • info

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

    • info

      added the optional property / to the response with the status

  • db3873ca3d4dRevision changes
    • info

      endpoint added