Skip to main content
POST
/
v2
/
lists
/
{id}
/
items
Add items to list
curl --request POST \
  --url https://api.village.do/v2/lists/{id}/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "identifier": "https://linkedin.com/in/john-doe",
      "type": "people"
    }
  ]
}
'
{
  "data": {
    "results": [
      {
        "identifier": "<string>",
        "item": {
          "id": 123,
          "graph_id": "<string>",
          "type": "people",
          "data": {},
          "created_at": "<string>"
        },
        "error": {
          "code": "DUPLICATE",
          "message": "<string>"
        }
      }
    ],
    "summary": {
      "total": 123,
      "added": 123,
      "failed": 123
    }
  },
  "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

id
string
required

List ID

Minimum string length: 1
Example:

"123"

Body

application/json

Request body for adding items to a list

items
object[]
required

Array of items to add to the list

Required array length: 1 - 100 elements

Response

Items processed

data
object
required

Response after adding items to a list

metadata
object
required