Update a person record

Purpose

Use this call to replace the strings stored with a person, to drop the stored image, or to move the record to another list with new_list_id.

Request

POST <API_BASE_URL>/person/update. All calls are POST under your API address. Replace <API_BASE_URL> with the API address provided with your access.

Send a permanent API token in the token field of the body, or a user token in the token header. See authentication.

Content type: application/json.

Field	Type	Required	Description
`token`	string (uuid)	if no header	Your permanent API token. Required unless you send a user token in the `token` header.
`person_id`	string	yes	The person to update.
`list_id`	string	no	The list the person is in now.
`fields`	array of string	no	The strings to store with the person.
`drop_image`	boolean	no	Drop the stored image.
`new_list_id`	string	no	Move the person to this list.

Response

HTTP 200. The record was updated.

Field	Type	Description
`status`	string	Always `ok` on this body.
`message`	string	Human-readable detail. Never branch on it.

Errors

400: The body failed validation. The answer has status of error and a details list with one entry per offending field (path, expected, actual).
401: The token is missing, expired or unknown.
404: A referenced entity does not exist.

A refusal can also come before the operation runs: an address outside your IP allowlist, a token bound to another address, or a body that is not valid JSON. See response format and errors.

Example

Request:

curl -X POST "<API_BASE_URL>/person/update" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "<your permanent API token>",
    "person_id": "<person id>",
    "list_id": "<person list id>",
    "fields": [
      "<your reference>"
    ]
  }'

Response:

{
  "status": "ok",
  "message": "<detail>"
}