Delete Record

DELETE 
/objects/:schemaKey/records/:id

Delete Record By Id . Supported Objects are business and custom objects.

Request

Version stringrequired

API Version

Available optionsv3

schemaKey stringrequired

The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.

id stringrequired

id of the record to be updated. Available on the Record details page under the 3 dots or in the url

application/json

Successful response

application/json

Schema

Schema

idstring

id of the deleted object

successboolean

boolean that defines if the operation was a success or not

Example (auto)

{
  "id": "661c06b4ffde146bdb469442",
  "success": true
}