/api/v1/object/data/{objectSlug}/bulk/allDelete all records of an object.
Delete all records of an object.
Deletes every record of the object, or only those created after
afterDate. The credential must have access to all records of the
object. deletedCount says how many records were deleted. When the run
fails part way, the response is still 200, with failedCount 1 and
a message in errors; records deleted before the failure stay deleted.
Query parameters:
afterDate— delete only records created after this date (YYYY-MM-DD) or ISO 8601 timestamp.
Scope: delete.<object slug>, for example delete.contacts.
Errors:
400— no active object has that slug.403— the credential does not have access to all records of the object.
Response 200:
{
"status": 200,
"message": "Bulk delete completed",
"data": {
"deletedCount": 1284,
"failedCount": 0,
"errors": []
}
}
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
Successful response
{
"message": "string",
"data": "string"
}Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs