Update a campaign agent

Partially update a Campaign Manager agent. Only the fields you send are changed; running campaigns keep the agent snapshot taken at launch.

PUT /api/v1/account/{account_id}/campaign/agents/{agent_id}

Update a campaign agent

cURL

curl --request PUT \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaign/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "answer_url": "<string>",
  "answer_method": "<string>",
  "hangup_url": "<string>",
  "hangup_method": "<string>",
  "static_headers": [
    {}
  ]
}
'

PUT https://api.vobiz.ai/api/v1/account/{account_id}/campaign/agents/{agent_id}

Updates are partial — only the fields you supply change.

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.

agent_id · string · required

ID of the agent, returned by Create an agent.

name · string

New agent name. Unique per account, maximum 100 characters.

answer_url · string

HTTPS URL called when the contact answers.

answer_method · string

GET or POST.

hangup_url · string

URL called when the call ends.

hangup_method · string

GET or POST.

static_headers · array

Replaces the existing array of { key, value } SIP headers.

Example

cURL

curl -X PUT \
  "https://api.vobiz.ai/api/v1/account/{account_id}/campaign/agents/{agent_id}" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{ "answer_url": "https://example.com/answer-v2" }'

Campaigns that are already running or queued use the agent snapshot frozen at launch. Your edit applies to the next launch, not to work already in flight.