v2

latestOpenAPI 3.0.02026-07-26365590.3 KB

Sequences

Create a sequence

Creates a new sequence. Use the /users endpoint to get organizationMembershipIds for assignedToIds and creatorId.

post/v1/sequences

Headers

x-workspace-idstring uuid

Target workspace id (from GET /v1/workspaces). Required for multi-workspace API keys to designate which workspace to write to; omit for single-workspace keys, where it is resolved automatically. Must be within the API key scope.

Request body

namestring required

Sequence name

assignedToIdsstring[] required

OrganizationMembership IDs of users to assign this sequence to

creatorIdstring required

OrganizationMembership ID of the creator. Use the /users endpoint to get available organizationMembershipIds.

contactIdsstring[]

Contact IDs to add to the sequence

Example request

{
  "name": "My Sales Sequence",
  "assignedToIds": [
    "123e4567-e89b-12d3-a456-426614174001",
    "123e4567-e89b-12d3-a456-426614174002"
  ],
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "contactIds": [
    "123e4567-e89b-12d3-a456-426614174010",
    "123e4567-e89b-12d3-a456-426614174011"
  ]
}

Response

Sequence created successfully

idstring required

Unique identifier of the sequence

namestring required

Name of the sequence

organizationMembershipIdstring required

OrganizationMembership ID of the creator

createdAtstring date-time required

Date when the sequence was created

updatedAtstring date-time required

Date when the sequence was last updated

contactCountnumber

Number of contacts in the sequence

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Sales Sequence",
  "organizationMembershipId": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "contactCount": 150,
  "assignedTo": [
    {
      "organizationMembershipId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "john.doe@example.com"
    }
  ]
}