v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Custom Object Records

Set Custom Object Record by External Id Or Name

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
patch/api/v2/custom_objects/{custom_object_key}/records

Path parameters

custom_object_keystring required

The key of a custom object

Query parameters

external_idstring required

The external id of a custom object record

namestring required

The name of a custom object record

Request body

Response

Success