POST
/
lists
curl --request POST \
  --url https://api.village.do/v1/lists \
  --header 'Content-Type: application/json' \
  --header 'secret-key: <api-key>' \
  --header 'user-identifier: <user-identifier>' \
  --data '{
  "title": "<string>",
  "type": "people",
  "description": "<string>",
  "is_public": false
}'
{
  "success": true,
  "data": {
    "id": 42,
    "title": "Seed investors",
    "type": "people",
    "description": "",
    "is_public": false,
    "fit_count": 0,
    "created_date": "2024-06-26T12:00:00Z"
  }
}

Authorizations

secret-key
string
header
required

Headers

user-identifier
string
required

Specify the user making the request. This identifier should match the one you used when integrating the user with Village.

Body

application/json

Response

201
application/json

List created

The response is of type object.