Support Ticket Errors
This API documents the 200 response for each operation. The API can return the following errors instead. Errors use the same envelope as a successful response, with status.status set to ERROR and the code in status.error_code.
Errors for all ticket endpoints
Error Code | Message |
|---|---|
| The signature or access key is missing or not valid. |
None (empty body) (HTTP 404) | The API is not enabled for the organization. |
| The support system or an internal call failed. See the action names for each endpoint below. |
Upload attachment
Error Code | Message |
|---|---|
| The file type is not allowed. |
| The file is larger than the size limit. The exact code can differ, because it comes from the upload library. |
| The request contains more than one file. |
| The request has no file, or the upload failed. |
| Authentication failed. |
| The upload is not enabled for the organization. |
Get ticket options
Error Code | Message |
|---|---|
| The support system or an internal call failed. |
Create ticket
Error Code | Message |
|---|---|
| A required field is missing. |
| A value is outside the allowed options, the subject is not valid for the category and environment, you send |
| A token has a bad format, is unknown, belongs to another organization, or is not a support ticket attachment. |
| The file extension is not allowed, or the file content does not match it. |
| A file is larger than the size limit. |
| |
| The support system or an internal call failed. |
List tickets
Error Code | Message |
|---|---|
| A query parameter is not valid. The code names the parameter. |
| The support system or an internal call failed. |
Get ticket
Error Code | Message |
|---|---|
| The ticket ID has a bad format. |
| The ticket does not exist, or it is not the caller's. |
| The support system or an internal call failed. |
Edit ticket
Error Code | Message |
|---|---|
| The request has nothing to change. |
| A value is not valid. |
| The ticket has the status |
| The ticket does not exist, or it is not the caller's. |
| The support system or an internal call failed. |
Close ticket
Error Code | Message |
|---|---|
| The ticket ID has a bad format. |
| The ticket does not exist, or it is not the caller's. |
| The support system or an internal call failed. |
Add comment
Error Code | Message |
|---|---|
| |
| A value is not valid. |
| A token or file is not acceptable. |
| The ticket has the status |
| The ticket does not exist, or it is not the caller's. |
| The support system or an internal call failed. |
Download attachment
Error Code | Message |
|---|---|
| An ID has a bad format. |
| The ticket does not exist, or it is not the caller's. |
| The file is not an attachment of this ticket, or the API cannot read it. |
| The support system or an internal call failed. |