JSON API » customers » customers/time/add
Increases a customer's available included call time. It's better to use this than customers/update as this is atomic.
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 customer to update. | Yes | |
seconds | Decimal | The number of seconds to add. | Yes | |
transaction | String | "add" to record an add time transaction, empty string to record no transaction. | No | Empty string. |
description | String | The description of the transaction. | No | Empty string. |
Responses
Code | Description |
---|---|
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 customer does not exist, or you do not have permission to update it. |
Data returned
No data is returned.
Example: With required parameters
http://enswitch.example.com/api/json/customers/time/add/?auth_username=user;auth_password=password;id=123;seconds=60{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |