PATCH /api/v2/custom_objects/{custom_object_key}/records
If a record exists for the given external id or name, updates it. Only the specified attributes are updated. Otherwise, creates a new record with the provided external id, name and other attributes. The is_unqiue property on the custom object's name field must be enabled in order to update or create by name. External id and name cannot be used together in the same request.
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" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
external_id |
String | Yes |
The external id of a custom object record |
name |
String | Yes |
The name of a custom object record |
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.