Delete API
This document explains how to use the API to delete records from a table.
Interface Description
Delete a specified record from a table.
Request Method
http
DELETE /api/bases/{base_id}/tables/{table_name}/records/{record_id}
Path Parameters
Parameter | Type | Description |
---|---|---|
base_id | string | Base ID |
table_name | string | Table name |
record_id | string | Record ID |
Request Headers
http
x-bm-token: your_api_token
Example Request
Delete a Single Record
http
DELETE /api/bases/base123/tables/table456/records/rec789
Response Format
Successful Response
json
{
"id": "11",
"name": "Deleted Record",
"created_by": "usrIL1t20OwVvW9jXzT",
"updated_by": "usrIL1t20OwVvW9jXzT",
"created_at": "2024-11-20T17:30:12.000Z",
"updated_at": "2024-11-20T17:30:27.000Z",
"creator": {
"id": "usrIL1t20OwVvW9jXzT",
"email": "[email protected]",
"name": "Dylan"
},
"modifier": {
"id": "usrIL1t20OwVvW9jXzT",
"email": "[email protected]",
"name": "Dylan"
}
}
Error Response
json
{
"message": "Record not found"
}
Notes
- Deleting a record is an irreversible operation, please use with caution
- If the record does not exist, a 404 error will be returned
- Deleting a record may affect associated fields in other tables