POST /api/v2/custom_objects/{custom_object_key}/records
Creates a custom object record according to all the properties described by a custom object definition. If autoincrement_enabled is true, record names aren't allowed in the request body because they are generated automatically. If is_unique is true, record names must be unique.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
custom_object_key |
String | Yes |
The key of a custom object |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
custom_object_record |
Object | No | |
custom_object_record.created_by_user_id |
String | No |
Id of a user who created the object |
custom_object_record.custom_object_fields |
Object | No | |
custom_object_record.id |
String | No |
Automatically assigned upon creation |
custom_object_record.external_id |
String | No |
An id you can use to link custom object records to external data |
custom_object_record.name |
String | Yes |
User-defined display name for the object. If autonumbering is selected for the custom object's name field, the name isn't allowed because it's automatically generated. If uniqueness is enabled, the name must be unique. |
custom_object_record.url |
String | No |
Direct link to the specific custom object |
custom_object_record.custom_object_key |
String | No |
A user-defined unique identifier |
custom_object_record.created_at |
String | No |
The time the object was created |
custom_object_record.updated_at |
String | No |
The time of the last update of the object |
custom_object_record.updated_by_user_id |
String | No |
Id of the last user who updated the object |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.