JSON API » requests » requests/update

Updates an existing request.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of request to update.Yes
responseStringResponse to requesting customer.NoCurrent value.
statusStringNew status. "approved", "deleted", "new", or "rejected".NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

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.
404The request does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Approving a request

http://enswitch.example.com/api/json/requests/update/?auth_username=user;auth_password=password;id=123;status=approved

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.13Function added.