Skip to content

Archive Sequence

POST
/sequences/{sequence_id}/archive

Archive a sequence - a soft delete.

NOT REVERSIBLE THROUGH THIS API TODAY. The app’s unarchive endpoint is a reserved stub that unconditionally returns 403 (“Unarchiving is not available yet”), so it is not published here - archiving is a one-way door for an API caller until that lands. Contact support to restore one.

A LIVE or WAITING sequence is paused first and wound down in the background; is_archived blocks every worker immediately. Archiving one that is already archived is a 400, and one mid-transition (scheduling, pausing) is a 409, so a retry loop cannot corrupt the state machine.

Authorizations

Parameters

Path Parameters

sequence_id
required

Sequence id.

string

Sequence id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string