Cancel reasons

Ticket cancel reasons describe the reasoning behind cancelled tickets.

Cancel reason

id	integer <int64> Cancel reason identifier.
allows_ticket_reopening	boolean Whether a ticket with this cancel reason can be reopened.
customer_fault	boolean Indicates if ticket with this reason was cancelled because of something the customer did.
manually_applicable	boolean Whether this cancel reason can be manually set by a ticket's operator.
name	string [ 1 .. 255 ] characters Human-readable description of the cancel reason.

{"id": 0,
"allows_ticket_reopening": true,
"customer_fault": true,
"manually_applicable": true,
"name": "Operation too risky."
}

Retrieve cancel reasons

Retrieve a list of possible ticket cancel reasons.

SecurityOAuth2 and ApiKey

Request

query Parameters

limit	integer <int32> [ 0 .. 1000 ] Default: 25 Limits the amount of resources in result.
offset	integer <int64> >= 0 Default: 0 Offset of resources in result.

Responses

200

Successful response.

Response Schema: application/json

object >= 0 properties

Applied query parameters, including defaults.

limit	integer <int32> [ 0 .. 1000 ] Default: 25 The applied value of the limit query parameter on the resources in result.
offset	integer <int64> >= 0 Default: 0 The applied value of the offset query parameter on the resources in result.
property name* additional property	any

Array of objects (Cancel reason) >= 0 items

List of ticket cancel reasons.

Array (>= 0 items)

id	integer <int64> Cancel reason identifier.
allows_ticket_reopening	boolean Whether a ticket with this cancel reason can be reopened.
customer_fault	boolean Indicates if ticket with this reason was cancelled because of something the customer did.
manually_applicable	boolean Whether this cancel reason can be manually set by a ticket's operator.
name	string [ 1 .. 255 ] characters Human-readable description of the cancel reason.

total

integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/cancel-reasons

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0
},
"result": [{"id": 0,
"allows_ticket_reopening": true,
"customer_fault": true,
"manually_applicable": true,
"name": "Operation too risky."
}
],
"total": 3255
}

Retrieve cancel reason

Retrieve a single cancel reason by its identifier.

SecurityOAuth2 and ApiKey

Request

path Parameters

cancel-reason-id

required

integer <int64>

The identifier of the cancel reason you want to retrieve.

Example: 3