Skip to content
Home/
REST API Reference
/
/
Ticket Type Attribute

Ticket Type Attribute

Ticket type attribute, used to define each data field to be captured in a ticket.

typestring

String representing the object's type. Always has the value ticket_type_attribute.

Example:"ticket_type_attribute"
idstring

The id representing the ticket type attribute.

Example:"1"
workspace_idstring

The id of the workspace that the ticket type attribute belongs to.

Example:"ecahpwf5"
namestring

The name of the ticket type attribute

Example:"Title"
descriptionstring

The description of the ticket type attribute

Example:"Bug title."
data_typestring

The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")

Example:"string"
input_optionsobject or null

Input options for the attribute. For a string attribute this holds multiline when it was set; for a list attribute it holds the list's options. When the attribute has no input options, this is null, or left out of the create and update ticket type attribute responses.

Example:
{
  "multiline": true
}
orderinteger

The order of the attribute against other attributes

Example:1
required_to_createboolean

Whether the attribute is required or not for teammates.

Default:false
Example:false
required_to_create_for_contactsboolean

Whether the attribute is required or not for contacts.

Default:false
Example:false
visible_on_createboolean

Whether the attribute is visible or not to teammates.

Default:true
Example:false
visible_to_contactsboolean

Whether the attribute is visible or not to contacts.

Default:true
Example:false
defaultboolean

Whether the attribute is built in or not.

Example:true
ticket_type_idinteger

The id of the ticket type that the attribute belongs to.

Example:42
archivedboolean

Whether the ticket type attribute is archived or not.

Example:false
created_atinteger, (timestamp)

The date and time the ticket type attribute was created.

updated_atinteger, (timestamp)

The date and time the ticket type attribute was last updated.

{
  "type": "ticket_type_attribute",
  "id": "1",
  "workspace_id": "ecahpwf5",
  "name": "Title",
  "description": "Bug title.",
  "data_type": "string",
  "input_options": {
    "multiline": true
  },
  "order": 1,
  "required_to_create": false,
  "required_to_create_for_contacts": false,
  "visible_on_create": false,
  "visible_to_contacts": false,
  "default": true,
  "ticket_type_id": 42,
  "archived": false,
  "created_at": 0,
  "updated_at": 0
}