JSON API » requests » requests/update
Updates an existing request.
Input parameters
Requires authentication and the commerce role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
id | Integer | ID of request to update. | Yes | |
response | String | Response to requesting customer. | No | Current value. |
status | String | New status. "approved", "deleted", "new", or "rejected". | No | Current value. |
validation | Integer | 1 to validate input then return, 0 for full action. | No | 0 |
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. |
404 | The 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
Version | Changes |
---|---|
3.13 | Function added. |