Field Value Model

Represents a value of a custom field. Depending on the custom field definition this can be assignable to parties, opportunities or cases.

Name Type Description
id Long Read only

The id of this value. Note that field values assignable to different entities (parties or opportunities) can have the same id.

value Multiple Required

The value of this field. For text custom fields value is a string. For date custom fields value is a string in the format YYYY-MM-DD. For list custom fields value is a string and must match one of the options specified in the custom field definition. For boolean custom fields value is a boolean. For number custom fields value can be passed as either a string or a number, but will always be returned as a string by the API.

definition Nested Field Definition Required

The custom field definition of this value.