Skip to main content
POST
/
api
/
v1
/
cdp
/
custom-objects
Upsert a custom object
curl --request POST \
  --url https://app.useboom.ai/api/v1/cdp/custom-objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "order",
  "externalId": "ord_998",
  "displayName": "Order #998",
  "attributes": {
    "total": 120.5,
    "status": "paid"
  }
}
'
{
  "type": "order",
  "externalId": "ord_998",
  "created": false
}

Authorizations

Authorization
string
header
required

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

Body

application/json
type
string
required

An existing custom object type name.

Required string length: 1 - 255
externalId
string
required
Required string length: 1 - 255
displayName
string
Required string length: 1 - 255
attributes
object

Free-form attributes. Full-replace on update.

Response

Custom object upserted

type
string
required
externalId
string
required
created
boolean
required