Sign in

v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Custom Fields

Update custom field by field name

Updates an existing custom field identified by its unique field name

put/v2/custom-fields/field-name/{fieldName}

Path parameters

fieldNamestring required

The unique field name of the custom field to update

Request body

labelstring

Display label for the custom field

fieldNamestring

Unique field name for API access (recommended for programmatic access)

descriptionstring

Description of the custom field

type'DROPDOWN' | 'MULTI_SELECT' | 'CHECKBOX' | 'TEXT' | 'TEXT_MULTILINE' | 'TEXT_ENCRYPTED' | 'NUMERIC' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'TIME' | 'ATTACHMENT' | 'NODE_DROPDOWN' | 'NODE_MULTI_SELECT' | 'CLIENT_DROPDOWN' | 'CLIENT_MULTI_SELECT' | 'CLIENT_LOCATION_DROPDOWN' | 'CLIENT_LOCATION_MULTI_SELECT' | 'CLIENT_DOCUMENT_DROPDOWN' | 'CLIENT_DOCUMENT_MULTI_SELECT' | 'EMAIL' | 'PHONE' | 'IP_ADDRESS' | 'WYSIWYG' | 'URL' | 'MONETARY' | 'IDENTIFIER' | 'TOTP'

The type of custom field that determines how data is stored and displayed

technicianPermission'NONE' | 'EDITABLE' | 'READ_ONLY' | 'ROLE_BASED'

Technician access level for custom fields

scriptPermission'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE'

Script access level for custom fields via automation

apiPermission'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE'

Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)

defaultValuestring

Default value for the custom field

activeboolean

Whether the custom field is active

scope'NODE_GLOBAL' | 'NODE_ROLE' | 'NODE_CLASS'

Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)

definitionScopestring[]

Definition scope for the custom field

groupIdinteger

Group ID for organizing custom fields

Response

Custom field updated successfully

entityType'USER' | 'NODE' | 'TICKET' | 'DOCUMENT'

Entity type that this custom field or operation applies to

scope'NODE_GLOBAL' | 'NODE_ROLE' | 'NODE_CLASS'

Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)

definitionScopestring[]

Definition Scope

type'DROPDOWN' | 'MULTI_SELECT' | 'CHECKBOX' | 'TEXT' | 'TEXT_MULTILINE' | 'TEXT_ENCRYPTED' | 'NUMERIC' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'TIME' | 'ATTACHMENT' | 'NODE_DROPDOWN' | 'NODE_MULTI_SELECT' | 'CLIENT_DROPDOWN' | 'CLIENT_MULTI_SELECT' | 'CLIENT_LOCATION_DROPDOWN' | 'CLIENT_LOCATION_MULTI_SELECT' | 'CLIENT_DOCUMENT_DROPDOWN' | 'CLIENT_DOCUMENT_MULTI_SELECT' | 'EMAIL' | 'PHONE' | 'IP_ADDRESS' | 'WYSIWYG' | 'URL' | 'MONETARY' | 'IDENTIFIER' | 'TOTP'

The type of custom field that determines how data is stored and displayed

labelstring

Label

descriptionstring

Description

namestring

Name

defaultValuestring

Default Value

endUserPermission'HIDDEN' | 'EDITABLE_OPTIONAL' | 'EDITABLE_REQUIRED' | 'READ_ONLY'

End user access level for custom fields in the UI

technicianPermission'NONE' | 'EDITABLE' | 'READ_ONLY' | 'ROLE_BASED'

Technician access level for custom fields

scriptPermission'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE'

Script access level for custom fields via automation

apiPermission'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE'

Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)

systemboolean

System

activeboolean

Active

createTimenumber double

Create Time

updateTimenumber double

Update Time