Skip to content

Delete custom object

delete

/custom_objects/objects/{type_name}/{external_id}

Use this endpoint to delete one custom object.

Prerequisites

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

Rate limit

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

Path parameters

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

Parameter Required Data Type Description
type_name Required String Custom object type machine name
external_id Required String Object identifier

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",
  "external_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/custom_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.

Parameter Required Data Type Description
deleted Required Boolean Whether the object deletion succeeded

Errors

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

Status Cause Guidance
404 Type not found or object not found Confirm type_name and external_id both exist in the workspace.
401 Missing or invalid REST API key Verify the Authorization header uses Bearer YOUR_REST_API_KEY and that the key is active.
403 API key lacks permission or request is blocked by allowlist Confirm the key has custom_objects.delete and that your source IP is on the key allowlist, if configured.
429 Rate limit exceeded Retry after X-RateLimit-Reset and reduce request frequency.
New Stuff!