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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of customer to update.Yes
secondsDecimalThe number of seconds to add.Yes
transactionString"add" to record an add time transaction, empty string to record no transaction.NoEmpty string.
descriptionStringThe description of the transaction.NoEmpty string.

Responses

CodeDescription
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 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

VersionChanges
3.13Function added.