Sign in

v3

latestOpenAPI 3.0.32026-07-31135300306.1 KB
custom-objects

Create a custom object

Creates a new custom object instance of the given type. To link the object to an account, pass the built-in Account relationship field in custom_fields: {"name":"Example","custom_fields":{"account":{"value":"account_uuid"}}}.

Rate limit: 20 requests per minute

post/custom-objects/{type}

Path parameters

typestring required

The type slug of the custom object (e.g. "companies").

Request body

custom_fieldsobject

Custom field values to set on the object, keyed by field slug. To link the object to an account, pass the built-in Account relationship field as custom_fields.account.value, for example {"custom_fields":{"account":{"value":"account_uuid"}}}.

namestring required

The name of the custom object.

Response

request_idstring