Skip to main content
POST
/
v2
/
sequences
/
{sequence_id}
/
leads
Add leads to sequence
curl --request POST \
  --url https://api.village.do/v2/sequences/{sequence_id}/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lead_identifiers": [
    "<string>"
  ]
}
'
{
  "data": {
    "added_leads": [
      {
        "id": "MLVEUwp4gsag4gMsc10q5g%3D%3D!vNnNM",
        "village_person_id": 123,
        "status": "active"
      }
    ],
    "skipped_leads": [
      {
        "village_person_id": 123,
        "reason": "<string>"
      }
    ]
  },
  "metadata": {
    "request_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Use the API token from your personal Village account: https://village.do/settings#api-keys

For verified apps accessing user data, create a user token: https://docs.village.do/api-reference-v2/authentication/create-authorization

Path Parameters

sequence_id
string
required

Encrypted sequence identifier

Minimum string length: 1
Example:

"MLVEUadsfgzdsafsc10q5g%3D%3D!vNnNM"

Body

application/json

Request to add leads to a sequence using lead identifiers (person IDs as strings or numbers)

lead_identifiers
(string | integer)[]
required
Required array length: 1 - 100 elements

Response

Leads added to sequence successfully

data
object
required
metadata
object
required