Delete data object

Use this endpoint to delete one data object.

important

Data Objects is generally available, but your workspace must be provisioned for Accounts before you can use this endpoint. To request provisioning, go to Data Settings > Accounts and complete the questionnaire. For details, see Enable Accounts.

Prerequisites

To use this endpoint, you need an API key with data_objects.delete.

Rate limit

This endpoint is in the Data Objects write bucket with a default limit of 1000 requests per minute.

Path parameters

The following table lists and describes the path parameters for the /data_objects/objects/{type_name}/{object_id} endpoint.

Example request

This section includes a sample path-parameter payload and a sample cURL request.

Sample request payload

Use this JSON object as a reference for the path parameters in this request.

1
2
3
4

{
  "type_name": "account",
  "object_id": "acct-123"
}

Sample cURL request

This example deletes the acct-123 account record.

1
2

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Response

This section includes a sample successful response and the response fields.

Example success response

The status code 200 could return the following response body.

1

{ "deleted": true }

The delete is synchronous. Deleting one object does not delete related objects.

Response parameters

The following table lists and describes the fields in a successful response.

Errors

The following table lists common errors for this endpoint and how to resolve them.