Sign in
Sequences

Remove a person from a sequence

Stops the sequence for one enrolled person and leaves the instance in status REMOVED. Requires a USER API key. note is an optional free-text comment persisted alongside the removal and surfaced in the recipient timeline.

post/public/v1/sequences/{sequenceId}/recipients/{instanceId}/remove

Path parameters

sequenceIdnumber nullable
Example:101
instanceIdnumber nullable
Example:9001

Request body

notestring

Example request

{
  "note": "example"
}

Response

Instance removed

idnumber required
accountIdnumber required
sequenceIdnumber required
personRowIdstring required
snapshotIdstring required
sourceSnapshotIdstring nullable
snapshotPinnedAtstring nullable
currentNodeIdstring nullable required
status'ACTIVE' | 'WAITING' | 'PAUSED' | 'COMPLETED' | 'EXITED' | 'FAILED' | 'REMOVED' required
blockedOn'NONE' | 'TIME' | 'TASK_COMPLETION' | 'REPLY' | 'MEETING' | 'MANUAL' | 'WORKFLOW_COMPLETION' required
nextExecutionAtstring nullable required
enrolledByUserIdnumber required
senderConnectedAccountIdnumber nullable required
startedAtstring nullable required
lastAdvancedAtstring nullable required
exitedAtstring nullable required
completedAtstring nullable required
pausedAtstring nullable required
removedAtstring nullable required
exitReasonstring nullable required
exitNotestring nullable required
exitedByUserIdnumber nullable required
failureReasonstring nullable required
failureCodestring nullable required
createdAtstring nullable required
updatedAtstring nullable required

Example response

{
  "id": 1,
  "accountId": 1,
  "sequenceId": 1,
  "personRowId": "example",
  "snapshotId": "example",
  "sourceSnapshotId": "example",
  "snapshotPinnedAt": "example",
  "currentNodeId": "example",
  "status": "ACTIVE",
  "blockedOn": "NONE",
  "nextExecutionAt": "example",
  "enrolledByUserId": 1,
  "senderConnectedAccountId": 1,
  "startedAt": "example",
  "lastAdvancedAt": "example",
  "exitedAt": "example",
  "completedAt": "example",
  "pausedAt": "example",
  "removedAt": "example",
  "exitReason": "example",
  "exitNote": "example",
  "exitedByUserId": 1,
  "failureReason": "example",
  "failureCode": "example",
  "createdAt": "example",
  "updatedAt": "example",
  "enrolledByUser": {
    "id": 1,
    "firstName": "example",
    "lastName": "example",
    "email": "user@example.com",
    "avatar": "example"
  },
  "exitedByUser": {
    "id": 1,
    "firstName": "example",
    "lastName": "example",
    "email": "user@example.com",
    "avatar": "example"
  }
}

Changes

Changed in 1 of the 2 revisions of this API.1