MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Bulk calls

Change rotation settings

Change how a campaign uses its number pool. Send only the fields you want to change. At least one field is required.

PUT/calls/bulk_call//rotation
Path parameters
bulk_call_idrequired
Body
7 fields
·

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients).

When to move to the next number: every calls_per_number calls, on low health score, both, or never. 

curl -X PUT 'https://omnidim.io/api/v1/calls/bulk_call/{bulk_call_id}/rotation' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_id": 1234
}'
Example response
{
  "status": "success",
  "message": "Rotation settings updated"
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

bulk_call_id*integer

Id of the bulk call campaign.

Request Body

application/json
user_id?ClientUserId

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.

strategy?string

When to move to the next number: every calls_per_number calls, on low health score, both, or never.

Value in"fixed_count""cpr_threshold""both""none"
calls_per_number?integer

Calls before moving on. Used by fixed_count and both.

health_threshold?number

Health score below which a number is rotated away from. Used by cpr_threshold and both.

fallback?string

When every number is unhealthy: pause the campaign, or continue_best with the healthiest one.

Value in"pause""continue_best"
call_back_from_different_number?boolean

When on, a repeat call to the same person goes out from a different number than the one that called them last. Needs two or more numbers in the pool. Must be true or false.

skip_known_invalid_numbers?boolean

When on, a contact is not dialed if the carrier said its number does not exist, in any campaign of your organization in the last 14 days. Must be true or false.

Response body

application/json

Response Body

Rotation settings updated.

application/json
status?string
message?string

Was this page helpful?

Change concurrency

Change how many calls the campaign places at once, including while it is running. Raise it to finish sooner, lower it if your team cannot keep up with transfers or your numbers are being answered less.

Retry contacts that did not connect

Re-queue contacts that did not connect, without creating a new campaign.