Skip to main content
POST
Create Campaign
Actual endpoint: POST https://api.ravan.ai/api/v1/campaigns/ (note the trailing slash)

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.

Body

string
required
The internal name of the resource. Use a clear name that your team can recognize in the dashboard and API responses.
string
required
The unique ID of the agent that should own, handle, or be assigned to this resource. Use the id returned by the Agent API.
string
required
The phone number record ID to use for calls or campaigns. Use the ID returned by the telephony endpoints.
string
required
The caller ID used for outbound calls, in E.164 format. The number must be purchased, imported, or connected in Agni.
string[]
required
A list of contact IDs to include in the request. Each ID must belong to a contact in your organization.
object
The campaign schedule settings. Use this object to define calling windows, timezone, concurrency, and retry behavior.

Response

boolean
Whether the request succeeded.
string
Human-readable status message.
object
Created campaign object.