Get early access

Ticket fields

Ticket fields: 4 operations of the ChaosDesk REST API.

Retrieves the collection of TicketField resources.

GET/api/ticket_fields

Responses

  • 200TicketField collection
  • 403Forbidden

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/ticket_fields" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Creates a TicketField resource.

POST/api/ticket_fields

Request body application/json

keystring
Stable machine key used in search/rules, e.g. "order_number".
titlestringrequired
type"text" | "textarea" | "dropdown" | "multiselect" | "date" | "integer" | "decimal" | "checkbox" | "regex" | "credit_card" | "lookup" | "currency"
descriptionstring | null
title_in_portalstring | null
Title shown to customers in the help centre (Zendesk title_in_portal); null = title.
agent_descriptionstring | null
Description only agents see (Zendesk agent_description); description is shown to end users.
required_to_solveboolean
Required for agents when solving (Zendesk behaviour).
visible_in_portalboolean
editable_in_portalboolean
required_in_portalboolean
activeboolean
positioninteger
regex_patternstring | null
optionsobject[]
options for dropdown/multiselect
relationship_target_typestring | null
Lookup fields (Zendesk lookup relationship fields): the related record type, see App\Lookup\LookupTarget.
relationship_filterobject | null
Lookup fields: conditions the related record must meet ({all: [...], any: [...]}, Zendesk relationship_filter), see App\Lookup\LookupFilter.

Responses

  • 201TicketField resource created
  • 400Invalid input
  • 403Forbidden
  • 422An error occurred

Example request

curl -X POST "https://yourcompany.chaosdesk.io/api/ticket_fields" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"title":"string"}'

Retrieves a TicketField resource.

GET/api/ticket_fields/{id}

Parameters

idstringpathrequired
TicketField identifier

Responses

  • 200TicketField resource
  • 403Forbidden
  • 404Not found

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/ticket_fields/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Updates the TicketField resource.

PATCH/api/ticket_fields/{id}

Parameters

idstringpathrequired
TicketField identifier

Request body application/merge-patch+json

titlestring
type"text" | "textarea" | "dropdown" | "multiselect" | "date" | "integer" | "decimal" | "checkbox" | "regex" | "credit_card" | "lookup" | "currency"
descriptionstring | null
title_in_portalstring | null
Title shown to customers in the help centre (Zendesk title_in_portal); null = title.
agent_descriptionstring | null
Description only agents see (Zendesk agent_description); description is shown to end users.
required_to_solveboolean
Required for agents when solving (Zendesk behaviour).
visible_in_portalboolean
editable_in_portalboolean
required_in_portalboolean
activeboolean
positioninteger
regex_patternstring | null
optionsobject[]
options for dropdown/multiselect
relationship_target_typestring | null
Lookup fields (Zendesk lookup relationship fields): the related record type, see App\Lookup\LookupTarget.
relationship_filterobject | null
Lookup fields: conditions the related record must meet ({all: [...], any: [...]}, Zendesk relationship_filter), see App\Lookup\LookupFilter.

Responses

  • 200TicketField resource updated
  • 400Invalid input
  • 403Forbidden
  • 404Not found
  • 422An error occurred

Example request

curl -X PATCH "https://yourcompany.chaosdesk.io/api/ticket_fields/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"title":"string","type":0}'