Custom Fields Overview

In Zylo, customizable fields can be created for applications. These fields (referred to commonly as "Custom Fields") allow for users to create their own updateable and filterable fields that are attached to the application.

The Zylo Enterprise API allows for users to filter and update on these custom fields that are attached to an application.

Filtering Custom Fields

Below is a table describing how each custom field type can be filtered on:

Type	Description	Example
`boolean`	Use `true` for "Yes" values and `false` for "No" values.	`?custom_fields[bool]=true`
`choice`	Use standard string filtering syntax.	`?custom_fields[dropdown]=option1,option2`
`currency`	Use standard number filtering syntax.	`?custom_fields[currency]=10,gt`
`date`	Use standard date filtering syntax.	`?custom_fields[date]=2024-01-01,gte`
`email`	Use standard string filtering syntax.	`?custom_fields[email][email protected]`
`number`	Use standard number filtering syntax.	`?custom_fields[number]=1,gte,5,lte`
`text`	Use standard string filtering syntax.	`?custom_fields[text]=engineering`

Updating Custom Fields

Below is a table describing how each custom field type can be updated:

Type	Description	Example
`boolean`	Use `true` for "Yes" values and `false` for "No" values.	`{ "custom_fields": { "bool": true } }`
`choice`	Use string value. Must match a current option.	`{ "custom_fields": { "dropdown": "option1" } }`
`currency`	Use number value.	`{ "custom_fields": { "currency": 100 } }`
`date`	Use date format `YYYY-MM-DD`. Does not accept times.	`{ "custom_fields": { "date": "2024-12-20" } }`
`email`	Use valid email format.	`{ "custom_fields": { "email": "[email protected]" } }`
`number`	Use number value.	`{ "custom_fields": { "number": 100 } }`
`text`	Use string value.	`{ "custom_fields": { "text": "example" } }`

You can update multiple custom fields at once in a single request, like below:

{
  "custom_fields": {
    "bool": true,
    "date": "2024-01-01"
  }
}