Sign in
Custom Fields

Bulk create custom fields

Creates multiple custom fields in a single request. All operations succeed or all fail.

post/v2/custom-fields/bulk

Request body

Response

All custom fields created 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

Changes

Changed in 1 of the 2 revisions of this API.33

  • 753f26d4665033See the full diff
    • ●

      added the new AOSP enum value to the items/content/advancedSettings/nodeClass/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new GLOBAL enum value to the items/definitionScope/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ROLE_BASED enum value to the items/technicianPermission response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new AOSP enum value to the request property customFields/items/content/advancedSettings/nodeClass/items/

      request-property-enum-value-added

    • ○

      added the new GLOBAL enum value to the request property customFields/items/definitionScope/items/

      request-property-enum-value-added

    • ○

      added the new ROLE_BASED enum value to the request property customFields/items/technicianPermission

      request-property-enum-value-added