Upsert Custom Object Records

Upserts multiple Custom Object Records.

It accepts a list of custom object records and creates or updates them if they already exist.
Each custom object record must provide either an external_id or combination of associated_resource_id and associated_resource_type to uniquely identify the CustomObjectRecord.

  • Alternatively to associated_resource_id, an associated_resource_data list can be provided, which is composed of a list of maps with the keys key and value. This list will be used to find the associated resource and get its ID.
    Example of associated_resource_data: [{"key": "phone", "value": "1234567890"}]

In case the custom object record should not be associated with a Whippy resource the associated_resource_id and associated_resource_type fields should be omitted, and only the external_id field should be provided.

Each custom object record must have a properties field in this format {"custom_property_key": "custom_property_value"}.

Each key in the properties field must be a valid custom property key for the custom object, in case of an invalid key, the custom object record will not be created or updated.

The value of each key in the properties field must be a valid value for the custom property, in case of an invalid value, the custom object record will not be created or updated.

In case a null value is provided for a custom property, the value of the custom property will be set to null, unless the custom property is required.

If an attempt is made to set a required custom property to null, the custom object record will not be created or updated.

Callback
Language
Authorization
Header
Click Try It! to start a request and see the response here!