v2

latestOpenAPI 3.0.02026-07-26365590.3 KB

Sequences

Add contacts to a sequence

Adds contacts to an existing sequence. Each item may optionally specify an assignedToWorkspaceMembershipId (a workspace membership id obtained via GET /v1/workspaces/:id/members). Items without assignedToWorkspaceMembershipId are auto-assigned via round-robin among the sequence assignees (least loaded first). Idempotent: duplicates, contacts already in the sequence, and contacts outside the sequence scope are silently ignored. Soft-deleted sequence-contacts are resurrected (their original assignee is preserved; an assignedToWorkspaceMembershipId in the body is ignored for resurrected rows). Returns 404 if the sequence is outside the API key scope. On concurrent requests for the same contact, the winner among competing assignedToWorkspaceMembershipId values is undefined; verify with GET /v1/sequences/:id/contacts.

post/v1/sequences/{id}/contacts

Path parameters

idstring required

Request body

Example request

{
  "contacts": [
    {
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "assignedToWorkspaceMembershipId": "987e6543-e21b-45d3-b678-426614174001"
    }
  ]
}

Response

Contacts added

{"stackTrail":"paths:/v1/sequences/{id}/contacts:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown","example":{"added":3}}

Example response

{
  "added": 3
}