Update a campaign

PUT

api

account

{account_id}

campaigns

{campaign_id}

Update a campaign

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>"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}"

payload = {
    "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>"
}
headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Auth-ID': '<x-auth-id>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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>'
  })
};

fetch('https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

string

required

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

string

required

Your Vobiz account ID, for example MA_XXXXXXXX.

string

required

ID of the campaign, returned by Create a campaign.

string

New campaign name. Maximum 100 characters.

integer

Must stay within the account concurrency limit.

string

fixed, per_contact, or pool.

string

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

string

ISO 8601 timestamp for a scheduled launch.

boolean

Set to true to remove an existing scheduled_at value.

boolean

Enables or disables the daily calling window.

integer

Range 0–5.

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.

Update a campaign

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>"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}"

payload = {
    "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>"
}
headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Auth-ID': '<x-auth-id>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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>'
  })
};

fetch('https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Example

Example