JSON API » tickets » tickets/update
Updates an existing ticket.
Input parameters
Requires authentication and the administrator or commerce role privileges.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
id | Integer | ID of ticket to update. | Yes | |
note_body | String | Note body. | No | Empty string. |
note_subject | String | Note subject. | No | Empty string. |
status | String | New status. "closed", "customer", or "parent". | No | Current value. |
validation | Integer | 1 to validate input then return, 0 for full action. | No | 0 |
Adding a note to a ticket using this function includes the note in the notification email, which adding the note separately does not. The note_subject is typically not set.
Responses
Code | Description |
---|---|
201 | Input passed validation. Only returned if validation=1. |
204 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
403 | Your rate plan does not allow this. |
404 | The ticket does not exist, or you do not have permission to update it. |
Data returned
No data is returned.
Example: Replying to a ticket
http://enswitch.example.com/api/json/tickets/update/?auth_username=user;auth_password=password;id=123;status=customer;note_body=This+is+a+reply{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
3.15 | Function added. |