v1

latestOpenAPI 3.0.02026-07-2633090.6 KB

campaign

Upload Campaign Contact List

Uploads a contact list for a campaign. Accepts a CSV file and campaign configuration as form data.

post/campaign/save

Headers

X-API-KEYstring required

Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Response

Contact list uploaded and campaign saved successfully.

messagestring

list_idstring

ID of the created campaign list

custom_args_valuesobject[]

Array of custom variables for each contact

total_rowsinteger

Total number of rows in uploaded CSV

successful_rowsinteger

Number of successfully processed rows

failed_rowsinteger

Number of rows that failed validation

Example response

{
  "message": "Contacts imported successfully!",
  "list_id": "123e4567-e89b-12d3-a456-426614174000",
  "custom_args_values": [
    {
      "callee_name": "John Doe",
      "company_name": "XYZ Corp",
      "mobile_number": "+1234567890"
    }
  ],
  "total_rows": 100,
  "successful_rows": 98,
  "failed_rows": 2
}