Sign in
Sequences

Cancel sequence enrollments

Cancels active or waiting enrollments in one sequence by subscriber ID or by matching stored entry event property values.

post/sequences/{sequenceId}/enrollments/cancel

Path parameters

sequenceIdstring required

Sequence ID

Request body

subscriberIdstring

Subscriber ID to cancel in this sequence.

fieldPathstring

Dot-path inside the token's stored entry event properties. If omitted, the sequence enrollmentFieldPath is used.

fieldValuesstring[]

Entry field values to match.

dryRunboolean

When true, returns matching enrollments without cancelling them. Field-value targeting defaults to dry run unless explicitly false.

reasonstring

Optional reason stored on cancelled enrollment tokens.

Example request

{
  "subscriberId": "sub_abc123",
  "fieldPath": "order.id",
  "fieldValues": [
    "ord_123",
    "ord_456"
  ],
  "reason": "Order cancelled"
}

Response

Enrollment cancellation completed or dry-run matches returned

successboolean
sequenceIdstring
dryRunboolean
targetobject
matchedCountnumber
cancelledCountnumber
hasMoreboolean
messagestring

Example response

{
  "success": true,
  "sequenceId": "seq_abc123",
  "matchedCount": 2,
  "cancelledCount": 2,
  "enrollments": [
    {
      "tokenId": "tok_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "customer@example.com",
      "status": "cancelled",
      "enrollmentKey": "event:ecommerce.order_placed:field:order.id:ord_123"
    }
  ],
  "message": "Cancelled 2 sequence enrollments."
}

Changes