JSON API » bulk » bulk/destinations/delete

Deletes one or all bulk campaign destinations.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
campaign	Integer	ID of campaign.	Yes
all	Integer	1 to delete all destinations in campaign, 0 to delete only the one specified by dnumber.	No	0
dnumber	String	Destination to delete.	Yes, unless all=1 is specified.	Empty string.

Either all=1 or dnumber must be specified.

Responses

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

Data returned

No data is returned.

Example: Deleting a single destination

http://enswitch.example.com/api/json/bulk/destinations/delete/?auth_username=user;auth_password=password;campaign=123;dnumber=2125551234

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

Change history

Version	Changes
3.13	Function added.