Skip to main content
POST
/
api
/
v1
/
cdp
/
custom-objects
/
types
Create a custom object type
curl --request POST \
  --url https://app.useboom.ai/api/v1/cdp/custom-objects/types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "invoice",
  "displayName": "Invoice",
  "description": "A billing invoice"
}
'
{
  "name": "invoice",
  "displayName": "Invoice",
  "description": "A billing invoice",
  "created": true
}

Authorizations

​
Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Body

application/json
​
name
string
required

Machine name used to reference the type (e.g. invoice). Unique per organization.

Required string length: 1 - 255
​
displayName
string
required

Human-readable label.

Required string length: 1 - 255
​
description
string
Required string length: 1 - 1000

Response

Custom object type created

​
name
string
required
​
displayName
string
required
​
description
string | null
required
​
created
boolean
required

Always true on a successful create (a duplicate name returns 409 instead).