JSON API » numbers » numbers/delete

Deletes a number from a customer and returns it to the pool.

Input parameters

Requires authentication and the administrator or wholesale role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
number	String	Number to delete.	Yes

Responses

Code	Description
204	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The number does not exist, or you do not have permission to delete it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/numbers/delete/?auth_username=user;auth_password=password;number=2125551234

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

Change history

Version	Changes
3.13	Function added.