v1Resources/Custom Fields/putSet a custom field value

Set a custom field value

Sets one custom-field value on a location or client. Pass null (or an empty value) to clear the field. The value is validated against the field's definition — for example, a select field's value must be one of its defined options.

put/api/v1/custom-fields/values
custom-fields:write
Request body
entityTypestring (location | client)required
The entity type this field applies to: "location" or "client".
entityIdstringrequired
ID of the location or client to set the value on.
keystringrequired
Key of the custom field definition to set, as returned in its key property.
valueobjectrequired
The value to store. Must be present in the request body, but may be null or empty to clear the field. Validated against the field's type and options.
Response
dataobjectoptional
valuesobjectoptional
The entity's custom field values, keyed by field key. A value is a string, a number, an array of strings (for multi_select), or absent when unset.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
422The request is missing a required parameter or is otherwise malformed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
put/api/v1/custom-fields/values
Your API key
Request body*
{
  "data": {
    "values": {
      "parking_notes": "Free lot behind the building."
    }
  }
}