v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB

campaigns

Update a batch

Updates a single Batch instance, currently batch can only be turned "on/off"

put/campaigns/batches/{id}

Path parameters

idinteger required

An id of a batch to update

Request body

idinteger

A id of a batch

namestring

A batch name

status'NEW' | 'VALIDATING' | 'ERRORS' | 'SOURCE_ERROR' | 'ACTIVE'

A status of batch (NEW, VALIDATING, ERRORS, SOURCE_ERROR, ACTIVE). NEW - batch is queued for validation; VALIDATING - batch is currently validating; ERRORS - batch is processed, some validation errors occurred; SOURCE_ERROR - if contact source is contact list in CallFire system and it has an error; ACTIVE - batch is processed and ready

broadcastIdinteger

An id of broadcast which batch belongs to

createdinteger

A date and time when batch was created, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

sizeinteger

A total number of contacts in batch

remaininginteger

A number of contacts remaining undialed/untexted

enabledboolean

An enabled batch. If batch is disabled its contacts remain undialed/untexted