Skip to main content
PATCH
Update Campaign
Actual endpoint: PATCH https://api.ravan.ai/api/v1/campaigns/{id}/

Authorizations

string
required
Your Agni API key used to authenticate the request. Pass it in the X-Api-Key header. Find or rotate it from your Ravan AI account settings.

Path Parameters

string
required
The unique ID of the campaign to update. Use the id returned by the List or Create Campaign endpoint.

Body

string
The campaign ID (can be included in the body).
string
The internal name of the campaign.
string
The unique ID of the agent assigned to this campaign.
string
The phone number record ID to use for this campaign.
string
The caller ID used for outbound calls, in E.164 format.
string
Campaign status: draft, active, paused, completed.
string
Execution state: draft, running, paused, completed.
object
Campaign schedule settings.

Response

boolean
Whether the request succeeded.
string
Human-readable status message. Example: Campaign updated successfully
object
Updated campaign object.