Validate Record Fields

POST 
/objects/:schemaKey/records/validate-fields

Validate custom object record properties against field schemas

Request

Version stringrequired

API Version

Available options2023-02-21

schemaKey stringrequired

The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location Id

propertiesobjectrequired

Record properties to validate against the object field schemas. Keys are the object field names; values are the field values.

Example (auto)

{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "properties": {
    "pet_name": "Cat",
    "pet_age": 10
  }
}

application/json

Fields validated successfully

application/json

Schema

Schema

propertiesobject[]

Validated properties in their internal storage shape

fieldsSchemasobject[]

Field schemas the properties were validated against

fieldsHashMapByKeyobject

Field schemas keyed by field key

droppedPropertiesobject[]

Properties that were dropped because they do not match any field schema

Example (auto)

{
  "properties": [
    {
      "key": "custom_objects.pet.pet_name",
      "valueString": "Cat"
    }
  ],
  "fieldsSchemas": [
    {
      "fieldKey": "custom_objects.pet.pet_name",
      "dataType": "TEXT"
    }
  ],
  "fieldsHashMapByKey": {
    "custom_objects.pet.pet_name": {
      "dataType": "TEXT"
    }
  },
  "droppedProperties": []
}