Skip to main content
DELETE
/
objects
/
{object_name}
/
records
/
{record_id}
cURL
curl --request DELETE \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_id} \
  --header 'x-api-key: <api-key>'
{
  "status": "success"
}

Overview

The delete method permanently removes a record by its unique ID from the specified object. This operation cannot be undone. If the record doesn’t exist, the API will return a 404 error. If the record is referenced by other records, those other records will not be deleted, but their reference to this record will be set to null.

Examples

This permanently deletes a company record:
DELETE /objects/company/records/349b4a49-38b7-407d-aeee-db4ead1bbae2
This removes the company permanently. Any people associated with this company will have their company attribute set to null.
This permanently deletes a record from a custom object:
DELETE /objects/product_user/records/5ff35db4-20de-4a12-9eef-ca0e9cc24818
This removes the record from the product_user object permanently.

Usage

Authorizations

x-api-key
string
header
required

Path Parameters

object_name
string
required
record_id
string
required

Response

Response for a successful delete operation.

status
enum<string>
required
Available options:
success
I