DELETE /api/v2/custom_objects/{custom_object_key}/records
Deletes a record with the specified external id or name. The is_unique property on the custom object's name field must be enabled in order to delete by name. External id and name cannot be used together in the same request.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
custom_object_key |
String | Yes |
The key of a custom object |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
external_id |
String | Yes |
The external id of a custom object record |
name |
String | Yes |
The name of a custom object record |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.