Skip to main content

​
Custom Objects

Custom objects use the same record, attribute, query, patch, archive, and relationship patterns as standard objects.

​
Supported actions

ActionSupport
CreateSupported
Read by IDSupported
QuerySupported
PatchSupported
ArchiveSupported
_assertNot available
RelationshipsGeneric relationship names
Attribute sub-resourcesNot available

​
Addressing a custom object

Use the custom object’s API name as the record type in the path. 
POST /api/v2/{object_api_name}
POST /api/v2/{object_api_name}/_query
GET  /api/v2/{object_api_name}/{record_id}
Custom object routes are matched after the standard record routes, so standard names such as contact, account, and opportunity keep their dedicated behavior.

​
Create a custom object record

{
  "attributes": {
    "display_name": "Website Redesign",
    "budget": 50000,
    "status": "in_progress"
  }
}
The available fields and value types depend on the workspace’s custom object configuration.

​
Unknown custom objects

If the custom object API name does not exist or is not available to the workspace, the API returns 404 unknown_record_type.

​
Common errors

Error codeUsually means
unknown_record_typeCustom object API name is unknown or unavailable
unknown_fieldField is not declared for that custom object
record_not_writableThe custom object is not writable in its current state
field_value_invalidValue did not match the custom field type