Automations · Sequences

Enroll contacts in a sequence

Enrolls contacts in a sequence.

POSThttps://api.pozy.ai/v1/sequences/{sequenceId}/enroll
enrollContacts

Guide: Sequences

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
sequenceIdrequiredstring

Request body

application/json, required

  • contactIdsarray of stringrequired
  • channelIdsarray of string

Example

curl -X POST "https://api.pozy.ai/v1/sequences/67ea9094754757c09f3c81ba/enroll" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contactIds": [
    "string"
  ]
}'

Response

200 on success

  • successboolean
  • enrolledinteger
  • failedinteger
  • resultsarray of object
    • contactIdstring
    • successboolean
    • errorstring
200 response
{
  "success": true,
  "enrolled": 1,
  "failed": 1,
  "results": [
    {
      "contactId": "642d31f43531ce7d44aa5013",
      "success": true,
      "error": "string"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Sequences