Create a new person list

Description

The method creates a new user person list. A JWT token in the header is required.

Request Format

  • HTTP method: POST
  • URL: /person/list/create
  • Content-Type: application/json
  • Authorization: required

Request Parameters

ParameterTypeLocationRequiredDescription
tokenstringHeaderUser JWT token

Request Body (JSON)

FieldTypeRequiredDescription
tokenstringUser JWT token
namestringName of the new list
list_idstringList identifier (optional)

Request Example (cURL)

curl -X POST "https://api.enface.ai/person/list/create"   -H "Content-Type: application/json"   -H "Authorization: Bearer jwt.temporary.token"   -d '{
    "token": "jwt.temporary.token",
    "name": "Colleagues",
    "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }'

Response Examples

Success (200 OK)
{
  "status": "ok"
}
Error (400 Bad Request)
{
  "message": "invalid schema",
  "status": "error"
}
Error (401 Unauthorized)
{
  "message": "access denied",
  "status": "error"
}
Error (404 Not Found)
{
  "message": "item with this id does not found",
  "status": "error"
}