v1

latestOpenAPI 3.0.02026-08-061478520.6 KB
[v3] Custom Fields

Create Custom Field Template

Create Custom Field Template

post/v3/custom-fields/template/create

Headers

Acceptstring
Example:application/json
Content-Typestring
Example:application/json

Request body

namestring required

Name of the custom field template

resourceType'user' | 'task' | 'entry' required

Key of the resource type this template applies to

requiredboolean

Whether this field is required

statusinteger

Status of the template

fieldType'number' | 'string' required

Type of the custom field

defaultValuestring nullable

Default value for the field (must match field type), must be provided if field is required

fieldOptionsobject[] nullable

Configuration options for the field

Example request

{
  "name": "Customer Priority",
  "resourceType": "user",
  "required": true,
  "fieldType": "number",
  "defaultValue": "Medium",
  "fieldOptions": []
}

Response

Custom field template created successfully