UserFields
Last updated
Last updated
Name
Type
ReadOnly
References
Description
Id [KEY]
Long
True
Automatically assigned upon creation.
Key
String
False
A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders.After a field is created, you cannot change its key.
Type
String
False
Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea.After a field is created, you cannot change its type
Title
String
False
The title of the custom field.
RawTitle
String
False
The dynamic content placeholder, if present, or the title value, if not.
Description
String
False
User-defined description of this field's purpose.
RawDescription
String
False
The dynamic content placeholder, if present, or the description value, if not.
Position
Integer
False
Ordering of the field relative to other fields.
Active
Boolean
False
If true, this field is available for use.
System
Boolean
True
If true, only active and position values of this field can be changed.
RegexpForValidation
String
False
Regular expression field only. The validation pattern for a field value to be deemed valid.
CreatedAt
Datetime
True
The time the ticket field was created.
UpdatedAt
Datetime
True
The time of the last update of the ticket field.
Tag
String
False
Optional for custom field of type checkbox; not presented otherwise.
CustomFieldOptions
String
False
Required and presented for a custom field of type dropdown.
Url
String
True
The URL for this resource.