Delete a list

Deletes a list with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
204

List deleted.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

409

Specified list is in use in a rule and cannot be deleted.

delete/lists/{id}
Request samples
const request = await api.lists.delete({id: 'my-second-key'});

// the request does not return any fields but
// you can confirm the success using the status code
console.log(request.response.status); // 204
Response samples
application/json
{
  • "status": 401,
  • "title": "string",
  • "detail": "string",
  • "instance": "string"
}