JSON API » bulk » bulk/destinations/update

Updates 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
status	String	The status to set. "cancelled", "failed", "pending", or "success".	Yes
all	Integer	1 to update all destinations in campaign, 0 to delete only those specified by dnumbers.	No	0
dnumbers	String	Destinations. If multiple, separate with commas.	Yes if all=0.	Empty string.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Either all=1 or dnumbers must be specified.

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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 campaign does not exist, or you do not have permission to update it.

Data returned

The number of destinations updated.

Example: With one destination

https://www.015pbx.net/local/api/json/bulk/destinations/update/?auth_username=user;auth_password=password;campaign=123;dnumbers=2125551234;status=success

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":"1" } }

Example: With two destinations

https://www.015pbx.net/local/api/json/bulk/destinations/update/?auth_username=user;auth_password=password;campaign=123;dnumbers=2125551234,2125551235;status=success

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":"2" } }

Example: All destinations

https://www.015pbx.net/local/api/json/bulk/destinations/update/?auth_username=user;auth_password=password;campaign=123;all=1;status=success

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":"2" } }