JSON API » bulk » bulk/campaigns/update

Updates an existing bulk campaign.

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
id	Integer	ID of campaign to update.	Yes
attempts	Integer	Number of times to try each destination.	No	Current value.
callerid	String	Callerid to send.	No	Current value.
description	String	Description.	No	Current value.
dtype	String	Destination type.	No	Current value.
dnumber	String	Destination number.	No	Current value.
enabled	Integer	1 to start calls, 0 not to.	No	Current value.
machine	String	What to do if an answering machine is detected. Empty string to disable detection, "failed" to mark the destination failed, "retry" to retry later, "success" to mark the destination as successful.	No	Current value.
maximum	Integer	The maximum concurrent calls to make.	No	Current value.
keep_agents_available	Integer	The number of agents that should be kept as available. Can be negative for queue destination to make more calls than available agents. 0 to disable	No	0
name	String	Name.	No	Current value.
owner	Integer	ID of owner. 0 for none.	No	Current value.
recordgroup	Integer	ID of record group. 0 for none.	No	Current value.
retry	Integer	How many seconds to retry after.	No	Current value.
success	String	"answer" to consider a destination successful on answer, "key" to consider it successful when a key is pressed.	No	Current value.
timegroup	Integer	ID of time group. 0 for none.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
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.
403	Your rate plan does not allow this.
404	The campaign does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/bulk/campaigns/update/?auth_username=user;auth_password=password;id=123;name=example

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

Change history

Version	Changes
4.2	keep_agents_available parameter added.
3.13	Function added.