Delete user relationship

Use this endpoint to remove one user-to-object relationship.

important

Custom Objects is currently in early access. Your workspace must be enabled before the Custom Objects API key permissions appear on Settings > API Keys.

Prerequisites

To use this endpoint, you need an API key with custom_objects.user_relationships.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}/users endpoint.

Request parameters

The following table lists and describes the JSON request body parameters for the /custom_objects/objects/{type_name}/{external_id}/users endpoint.

note

This DELETE endpoint expects a JSON request body. Validate that your HTTP client sends request bodies on DELETE calls.

Example request

This section includes a sample JSON payload and a sample cURL request.

Sample request payload

1
2
3
4
{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}

Sample cURL request

This example removes the account_user relationship between the specified user and acct-123. The user profile and the account record both remain.

1
2
3
4
5
6
7
curl --location --request DELETE 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123/users' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}'

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 }

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.