Twenty CRM icon

Twenty CRM

Interact with Twenty CRM - Open Source CRM

Custom Object → Delete

AI-generated

Summary

Delete a record of a specified custom object in Twenty CRM by its record ID.

Inputs

  • Object API Name (required) — The API name of the custom object (the plural name used in the API endpoint, e.g., 'customLeads'). Found in Twenty CRM Settings > Data Model > Your Object > API Name.
  • Record ID (required) — The ID of the record to delete from the specified custom object.
  • Options — Optional parameters including 'Depth' to specify the depth of relations to include in the response (0-2).

Output shape

a JSON object representing the deletion response from Twenty CRM, potentially including relation data up to the specified depth

The response includes details about the deletion operation. The 'Depth' option controls relational data included in the response. This operation requires both the object API name and record ID to be provided. Errors from the API are surfaced if the record cannot be deleted.

Examples

Example 1: Delete a custom object record by API name and record ID

Set 'Object API Name' to the target custom object's API name (e.g., 'customLeads'), input the 'Record ID' of the record to delete, optionally configure 'Depth' to control relational data returned, then execute the node to perform the deletion.

Links

Discussion