Create custom object

Use this endpoint to create one custom object for a type.

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.create.

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} endpoint.

Request parameters

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

Example request

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

Sample request payload

1
2
3
4
5
6
7
{
  "external_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}

Sample cURL request

This example creates an account record with the identifier acct-new and sets its name and industry attributes.

1
2
3
4
5
6
7
8
9
10
curl --location --request POST 'https://rest.iad-01.braze.com/custom_objects/objects/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "external_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}'

Response

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

Example success response

The status code 201 could return the following response body.

1
2
3
4
5
6
7
{
  "custom_object": {
    "type_name": "account",
    "external_id": "acct-new",
    "attributes": { "name": "New Account", "industry": "software" }
  }
}

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.