Sign in
Sequences

Create sequence

Creates a DRAFT sequence with a server-owned Start node. Idempotency-Key may be supplied to safely replay the request.

post/public/v1/sequences

Headers

idempotency-keystring
Example:example value

Request body

namestring required
descriptionstring nullable

Example request

{
  "name": "example",
  "description": "example"
}

Response

Previously completed idempotent response

idnumber required
namestring required
descriptionstring nullable
status'LIVE' | 'DRAFT' | 'DELETED' required
createdAtstring nullable required
updatedAtstring nullable required
liveSnapshotIdstring nullable required
draftSnapshotIdstring nullable required
stopOnReplyboolean
stopOnMeetingboolean
trackOpensboolean
trackClicksboolean
timezonestring nullable
myLevel'FULL_ACCESS' | 'CAN_ENROLL' | 'VIEW' | 'NONE'

Example response

{
  "id": 1,
  "name": "example",
  "description": "example",
  "owner": {
    "id": 1,
    "firstName": "example",
    "lastName": "example",
    "email": "user@example.com",
    "avatar": "example"
  },
  "status": "LIVE",
  "createdAt": "example",
  "updatedAt": "example",
  "liveSnapshotId": "example",
  "draftSnapshotId": "example",
  "deliveryWindow": {
    "allowedWeekdays": [
      1
    ]
  },
  "timezone": "example",
  "myLevel": "FULL_ACCESS"
}

Changes

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