Get early access

Ticket forms

Ticket forms: 5 operations of the ChaosDesk REST API.

Retrieves the collection of TicketForm resources.

GET/api/ticket_forms

Responses

  • 200TicketForm collection
  • 403Forbidden

Example request

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

Creates a TicketForm resource.

POST/api/ticket_forms

Request body application/json

namestringrequired
display_namestring | null
Name shown to customers in the help centre (defaults to name).
positioninteger
activeboolean
defaultboolean
end_user_visibleboolean
field_idsstring[]
ticket field ids, in display order
conditionsobject[]
agent conditions (Zendesk agent_conditions)
end_user_conditionsobject[]
help-centre conditions (Zendesk end_user_conditions); same shape as conditions
brand_idsstring[]
brand ids the form is offered for (Zendesk restricted_brand_ids); empty = every brand

Responses

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

Example request

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

Retrieves a TicketForm resource.

GET/api/ticket_forms/{id}

Parameters

idstringpathrequired
TicketForm identifier

Responses

  • 200TicketForm resource
  • 403Forbidden
  • 404Not found

Example request

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

Updates the TicketForm resource.

PATCH/api/ticket_forms/{id}

Parameters

idstringpathrequired
TicketForm identifier

Request body application/merge-patch+json

namestring
display_namestring | null
Name shown to customers in the help centre (defaults to name).
positioninteger
activeboolean
defaultboolean
end_user_visibleboolean
field_idsstring[]
ticket field ids, in display order
conditionsobject[]
agent conditions (Zendesk agent_conditions)
end_user_conditionsobject[]
help-centre conditions (Zendesk end_user_conditions); same shape as conditions
brand_idsstring[]
brand ids the form is offered for (Zendesk restricted_brand_ids); empty = every brand

Responses

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

Example request

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

Removes the TicketForm resource.

DELETE/api/ticket_forms/{id}

Parameters

idstringpathrequired
TicketForm identifier

Responses

  • 204TicketForm resource deleted
  • 403Forbidden
  • 404Not found

Example request

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