JSON API » bulk » bulk/campaigns/update

Updates an existing bulk campaign.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of campaign to update.Yes
attemptsIntegerNumber of times to try each destination.NoCurrent value.
calleridStringCallerid to send.NoCurrent value.
descriptionStringDescription.NoCurrent value.
dtypeStringDestination type.NoCurrent value.
dnumberStringDestination number.NoCurrent value.
enabledInteger1 to start calls, 0 not to.NoCurrent value.
machineStringWhat 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.NoCurrent value.
maximumIntegerThe maximum concurrent calls to make.NoCurrent value.
nameStringName.NoCurrent value.
ownerIntegerID of owner. 0 for none.NoCurrent value.
recordgroupIntegerID of record group. 0 for none.NoCurrent value.
retryIntegerHow many seconds to retry after.NoCurrent value.
successString"answer" to consider a destination successful on answer, "key" to consider it successful when a key is pressed.NoCurrent value.
timegroupIntegerID of time group. 0 for none.NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your rate plan does not allow this.
404The 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

VersionChanges
3.13Function added.