/record - Array Input Version

View as Markdown
## DELETE /record — Array (Bulk) Input Version Bulk-delete one or more dataset records by supplying an array of record UUIDs in the request body. This is the preferred approach when you need to remove multiple records in a single API call. --- ### Summary This endpoint deletes one or more records from a dataset. Rather than targeting a single record via a path variable (as in `DELETE /record/{record_uuid}`), this variant accepts a JSON body containing a `record_uuids` array, making it possible to delete multiple records atomically in one request. --- ### Contrast with the Single-Record Variant | Feature | This endpoint | `DELETE /record/{record_uuid}` | | --- | --- | --- | | Input method | JSON body (`record_uuids` array) | Path variable | | Records per call | One or more | Exactly one | | Use case | Bulk deletion | Single targeted deletion | --- ### Request Headers | Header | Value | Description | | --- | --- | --- | | `Content-Type` | `application/json` | Indicates the request body is JSON. | | `Authorization` | `Bearer {{token}}` | Bearer token required for all authenticated requests. | --- ### Authentication Authentication is handled automatically via a **pre-request script** that: 1. POSTs to `{{url}}/token` using the `apiuser` and `apipass` environment variables as credentials. 2. Stores the returned access token in the `token` variable. 3. Sends the token as a `Bearer` token in the `Authorization` header. Ensure the `url`, `apiuser`, and `apipass` variables are set in your active environment before sending this request. --- ### Request Body **Content-Type:** `application/json` | Field | Type | Required | Description | | --- | --- | --- | --- | | `record_uuids` | `string[]` | ✅ Yes | An array of one or more record UUID strings to delete. | **Example:** ``` json { "record_uuids": [ "3cbdf225b91bb2fc4d729df34c38" ] } ``` Multiple UUIDs can be included in the array to delete several records in a single request. --- ### Permissions The authenticated user must have **appropriate delete permissions** for the target dataset records. Requests from users without sufficient permissions will be rejected. --- ### Expected Responses | Status Code | Description | | --- | --- | | `200 OK` | All specified records were successfully deleted. | | `400 Bad Request` | The request body is malformed or `record_uuids` is missing/empty. | | `401 Unauthorized` | The Bearer token is missing, invalid, or expired. | | `403 Forbidden` | The authenticated user does not have permission to delete one or more of the specified records. | | `404 Not Found` | One or more of the provided UUIDs do not correspond to existing records. | | `500 Internal Server Error` | An unexpected server-side error occurred. |

Request

This endpoint expects an object.
record_uuidslist of stringsRequired

Response headers

:statusstringOptional
cache-controlstringOptional
access-control-allow-originstringOptional
access-control-allow-methodsstringOptional
access-control-allow-headersstringOptional
access-control-expose-headersstringOptional
access-control-max-agestringOptional

Response

OK
deletedlist of strings
countinteger