Delete a person list

Purpose

Use this call to delete a person list. The persons in the list are deleted with it. This cannot be undone.

Request

POST <API_BASE_URL>/person/list/delete. 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.
`list_id`	string (uuid)	no	The list to delete.
`name`	string	no	The name of the list to delete.

Response

HTTP 200. The list and its persons were deleted.

Field	Type	Description
`status`	string	Always `ok` on this body.

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.

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/list/delete" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "<your permanent API token>",
    "list_id": "<person list id>"
  }'

Response:

{
  "status": "ok"
}