Skip to main content
POST
/
campaign
/
save
Upload Campaign Contact List
curl --request POST \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/save \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-KEY: <x-api-key>' \
  --form 'variables_map=<string>' \
  --form 'agent_id=<string>' \
  --form 'call_config=<string>' \
  --form 'country_code=<string>' \
  --form campaign_start_time=2023-11-07T05:31:56Z \
  --form campaign_end_time=2023-11-07T05:31:56Z \
  --form 'campaign_name=<string>' \
  --form file=@example-file
{
  "message": "Campaign contact list uploaded successfully."
}

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Body

multipart/form-data
​
variables_map
string

(Required) JSON string mapping variable names to columns.

​
agent_id
string

(Required) Unique identifier for the agent.

​
call_config
string

(Required) JSON string of call configuration.

​
country_code
string

(Required) Country code for the campaign.

​
campaign_start_time
string<date-time>

(Required) Start time for the campaign (ISO 8601).

​
campaign_end_time
string<date-time>

(Required) End time for the campaign (ISO 8601).

​
campaign_name
string

(Required) Name of the campaign.

​
file
file

(Required) CSV file containing the contact list.

Response

Contact list uploaded and campaign saved successfully.

​
message
string
Example:

"Campaign contact list uploaded successfully."

⌘I