JSON API » callshops » callshops/lock

Locks a callshop customer so that they cannot make calls.

Input parameters

Requires authentication and the callshop role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
customer	Integer	ID of customer to lock.	Yes

Responses

Code	Description
204	Success.
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 view it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/callshops/lock/?auth_username=user;auth_password=password;customer=123

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

Change history

Version	Changes
3.13	Function added.