Skip to main content
PUT
/
v2
/
sequences
/
{sequence_id}
/
leads
/
{lead_id}
Update sequence lead
curl --request PUT \
  --url https://api.village.do/v2/sequences/{sequence_id}/leads/{lead_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "active",
  "selected_introducers": [
    {
      "linkedin_identifier": "<string>",
      "rank": 2,
      "name": "<string>"
    }
  ],
  "next_followup_at": "2023-11-07T05:31:56Z"
}
'
{
  "data": {
    "id": "MLVEUwp4gsag4gMsc10q5g%3D%3D!vNnNM",
    "sequence_id": "MLVEUadsfgzdsafsc10q5g%3D%3D!vNnNM",
    "village_person_id": 1,
    "status": "active",
    "next_followup_at": "2023-11-07T05:31:56Z",
    "selected_introducers": [
      {
        "linkedin_identifier": "<string>",
        "rank": 2,
        "name": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "person": {
      "id": 1,
      "first_name": "<string>",
      "last_name": "<string>",
      "full_name": "<string>",
      "linkedin_url": "<string>",
      "linkedin_identifier": "<string>",
      "headline": "<string>",
      "location": {
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      },
      "position": {
        "title": "<string>",
        "company": {
          "id": "<string>",
          "name": "<string>",
          "linkedin_url": "<string>",
          "domain": "<string>"
        },
        "start_date": "<string>",
        "end_date": "<string>"
      },
      "image_url": "<string>",
      "email": "[email protected]"
    },
    "latest_update": "<string>",
    "latest_update_date": "2023-11-07T05:31:56Z"
  },
  "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"

lead_id
string
required

Encrypted lead identifier

Minimum string length: 1
Example:

"MLVEUwp4gsag4gMsc10q5g%3D%3D!vNnNM"

Body

application/json

Request to update a sequence lead

status
enum<string>

Status of the lead within the sequence

Available options:
active,
not_started,
pending,
finished,
deleted
selected_introducers
object[] | null
next_followup_at
string<date-time> | null

Response

Lead updated successfully

data
object
required

Sequence lead with person data and latest activity information

metadata
object
required