Skip to main content
PATCH
/
api
/
v1
/
campaigns
/
{id}
Update Campaign
curl --request PATCH \
  --url https://api.ravan.ai/api/v1/campaigns/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "agent_id": "<string>",
  "phone_number_id": "<string>",
  "from_phone_number": "<string>",
  "schedule": {
    "start": "<string>",
    "end": "<string>",
    "window_start": "<string>",
    "window_end": "<string>",
    "window_days": [
      123
    ],
    "timezone": "<string>",
    "max_concurrent": 123,
    "retry_attempts": 123,
    "retry_gap_min": 123
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "organization_id": "<string>",
    "name": "<string>",
    "agent_id": "<string>",
    "phone_number_id": "<string>",
    "from_phone_number": "<string>",
    "status": "<string>",
    "execution_status": "<string>",
    "schedule": {
      "start": "<string>",
      "end": "<string>",
      "window_start": "<string>",
      "window_end": "<string>",
      "window_days": [
        123
      ],
      "timezone": "<string>",
      "max_concurrent": 123,
      "retry_attempts": 123,
      "retry_gap_min": 123
    },
    "contact_stats": {
      "total": 123,
      "contacted": 123,
      "successful": 123,
      "failed": 123,
      "no_answer": 123,
      "pending": 123,
      "in_progress": 123
    },
    "started_at": "<string>",
    "completed_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.ravan.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Api-Key
string
required
Your Agni API key. Find it in your RavanAi.

Path Parameters

id
string
required
Campaign ID

Body

name
string
Campaign name
agent_id
string
Agent UUID
phone_number_id
string
Phone number record ID
from_phone_number
string
Caller ID in E.164 format
contact_ids
string[]
Array of contact UUIDs
schedule
object
Campaign schedule configuration

Response

success
boolean
Whether the request succeeded.
message
string
Human-readable status message.
data
object
Updated campaign object.

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Campaign ID

Body

application/json
name
string
agent_id
string
phone_number_id
string
from_phone_number
string
schedule
object

Response

200 - application/json

Successful response

success
boolean
message
string
data
object