Skip to main content

DELETE - Batch delete check lists

Batch delete check lists

Request​

  • Method: DELETE
  • Endpoint: /check-lists/batch
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: batch-delete-check-lists

Authorization​

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Request Body​

Required: no Content-Type: application/json Schema: array

Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "format": "uuid"
  }
}

Example: example-1​

[
  "ec946270-545c-4e51-ac5d-a6980dbd1575",
  "261be68e-df86-4705-ac33-ba318996f155"
]

Responses​

204 No Content​

400 Bad Request​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "invalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

401 Unauthorized​

404 Not Found​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

406 Not Acceptable​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "mismatch in the types of content",
  "code": "not.acceptable",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

500 Internal Server Error​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}