Update a campaign

Partially update a draft or ready campaign — concurrency, caller-ID settings, schedule, daily window, retries, and webhook URL.

PUT /api/v1/account/{account_id}/campaigns/{campaign_id}

Update a campaign

cURL

curl --request PUT \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "max_concurrent": 123,
  "caller_id_strategy": "<string>",
  "fixed_caller_id": "<string>",
  "scheduled_at": "<string>",
  "clear_schedule": true,
  "window_enabled": true,
  "retry_attempts": 123,
  "notify_url": "<string>"
}
'

PUT https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}

Every field is optional — only what you send changes.

Authentication required

• X-Auth-ID — your Vobiz account ID
• X-Auth-Token — your Vobiz auth token

account_id · string · required

Your Vobiz account ID. Use the same value in X-Auth-ID.

X-Auth-ID · string · required

Your Vobiz account ID, for example MA_XXXXXXXX.

campaign_id · string · required

ID of the campaign, returned by Create a campaign.

name · string

New campaign name. Maximum 100 characters.

max_concurrent · integer

Must stay within the account concurrency limit.

caller_id_strategy · string

fixed, per_contact, or pool.

fixed_caller_id · string

E.164 caller ID, required while the strategy is fixed.

scheduled_at · string

ISO 8601 timestamp for a scheduled launch.

clear_schedule · boolean

Set to true to remove an existing scheduled_at value.

window_enabled · boolean

Enables or disables the daily calling window.

retry_attempts · integer

Range 0–5.

notify_url · string

Target for signed campaign and contact webhooks.

Example

cURL

curl -X PUT \
  "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{ "max_concurrent": 25, "clear_schedule": true }'

A campaign can be updated only while it is draft or ready. Editing a running, paused, queued, or archived campaign returns 409 Conflict.