JSON API » tickets » tickets/update

Updates an existing ticket.

Input parameters

Requires authentication and the administrator or commerce role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of ticket to update.Yes
note_bodyStringNote body.NoEmpty string.
note_subjectStringNote subject.NoEmpty string.
statusStringNew status. "closed", "customer", or "parent".NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

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

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your rate plan does not allow this.
404The 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

VersionChanges
3.15Function added.