Custom Field

Example

{
"assignedCategoryIds": [],
"defaultValue": null,
"id": 42623,
"isHidden": false,
"isRequired": false,
"isSensitiveData": false,
"name": "Shop region",
"order": 1,
"placeholder": "region",
"possibleValues": [
{
"order": 1,
"value": "Østfold"
},
{
"order": 2,
"value": "Akershus"
},
{
"order": 3,
"value": "Oslo"
}
],
"type": "region",
"value": null
}

Fields

Field

Type

Comments

AssignedCategoryIds

array of integer

Ids of categories which tickets should contain this field.

DefaultValue

string

string containing default value. Format of string depends on field type (correct formats can be checked in this document).

Id

integer

Unique Id of custom field.

IsHidden

boolean

If true custom field should be hidden from public ticket forms.

IsRequired

boolean

If true fulfilling this field is required for ticket with categories field assigned to.

IsSensitiveData

boolean

If true field values will be deleted after ticket anonymization due to GDPR.

Name

string

name of custom field.

Order

integer

Order of showing on web forms or other public places. (fields with less number will be shown before fields with bigger).

Placeholder

string

Text of placeholder of field

PossibleValues

array of possible values

array of possible value for custom field

Type

string

Type of custom field (ex. "text_input", "email", "date") List of all possible type can be found in this document.

Value

string

string containing value. Format of string depends on field type (correct formats can be checked in this document).