node-zendesk / Exports / clients/core/ticketfields

Module: clients/core/ticketfields

Table of contents

Classes

• TicketFields

Type Aliases

• TicketField

Type Aliases

TicketField

Ƭ TicketField: Object

Type declaration

Name	Type	Description
active	boolean	- Whether this field is available
agent_description	string	- A description of the ticket field that only agents can see
collapsed_for_agents	boolean	- If true, the field is shown to agents by default. If false, the field is hidden alongside infrequently used fields. Classic interface only
created_at	string	- The time the custom ticket field was created
creator_app_name	string	- Name of the app that created the ticket field, or a null value if no app created the ticket field
creator_user_id	number	- The id of the user that created the ticket field, or a value of "-1" if an app created the ticket field
custom_field_options	any[]	- Required and presented for a custom ticket field of type "multiselect" or "tagger"
custom_statuses	any[]	- List of customized ticket statuses. Only presented for a system ticket field of type "custom_status"
description	string	- Describes the purpose of the ticket field to users
editable_in_portal	boolean	- Whether this field is editable by end users in Help Center
id	number	- Automatically assigned when created
position	number	- The relative position of the ticket field on a ticket. Note that for accounts with ticket forms, positions are controlled by the different forms
raw_description	string	- The dynamic content placeholder if present, or the description value if not. See Dynamic Content
raw_title	string	- The dynamic content placeholder if present, or the title value if not. See Dynamic Content
raw_title_in_portal	string	- The dynamic content placeholder if present, or the "title_in_portal" value if not. See Dynamic Content
regexp_for_validation	string	- For "regexp" fields only. The validation pattern for a field value to be deemed valid
relationship_filter	object	- A filter definition that allows your autocomplete to filter down results
relationship_target_type	string	- A representation of what type of object the field references. Options are "zen:user", "zen:organization", "zen:ticket", or "zen:custom_object:{key}" where key is a custom object key. For example "zen:custom_object:apartment".
removable	boolean	- If false, this field is a system field that must be present on all tickets
required	boolean	- If true, agents must enter a value in the field to change the ticket status to solved
required_in_portal	boolean	- If true, end users must enter a value in the field to create the request
sub_type_id	number	- For system ticket fields of type "priority" and "status". Defaults to 0. A "priority" sub type of 1 removes the "Low" and "Urgent" options. A "status" sub type of 1 adds the "On-Hold" option
system_field_options	any[]	- Presented for a system ticket field of type "tickettype", "priority" or "status"
tag	string	- For "checkbox" fields only. A tag added to tickets when the checkbox field is selected
title	string	- The title of the ticket field
title_in_portal	string	- The title of the ticket field for end users in Help Center
type	string	- System or custom field type. Editable for custom field types and only on creation. See Create Ticket Field
updated_at	string	- The time the custom ticket field was last updated
url	string	- The URL for this resource
visible_in_portal	boolean	- Whether this field is visible to end users in Help Center

Defined in

clients/core/ticketfields.d.ts:1