Create Custom Object Record

Creates a new custom object record, or updates an existing one if a duplicate is found.

This endpoint performs an upsert operation:

  • If a custom object record with the same external_id exists, it will be updated
  • If a custom object record with the same associated_resource_id and associated_resource_type combination exists, it will be updated
  • If no matching record exists, a new custom object record will be created

When updating an existing record, the properties are merged:

  • Existing properties not included in the request are preserved
  • Properties included in the request are updated with the new values
  • New properties can be added to the existing record

The custom object with its custom properties must be created before creating a custom object record. The associated_resource_id field is used to associate the custom object record with a Whippy resource. The associated_resource_type field is used to specify the type of the Whippy resource e.g. contact, conversation, message, tag. The properties field is used to specify what custom properties should be set for the custom object record and their values. If the custom object has a required custom property, and its key is not present in the properties field, then the default value of the custom property will be used.

Note: When updating via this endpoint, validation rules still apply to the merged data. Required properties must be present in the final merged result.

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