Sign in
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: 120 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.

Example request

{
  "custom_fields": {
    "account": {
      "value": "account_uuid"
    }
  }
}

Response

request_idstring

Example response

{
  "data": {
    "custom_fields": {
      "priority": {
        "value": "high"
      }
    }
  }
}

Changes