Ringover Campaigns API

Manage your outbound call campaigns (Call Lists). This section provides a comprehensive overview of how to manage your campaign workflows: - Retrieve the list of campaigns, filterable by various parameters. - Assign Ringover users to specific campaigns. - Add or manage contacts associated with a campaign. - Start, stop, or reset campaigns dynamically. - Update campaign scripts to ensure consistent messaging. - Adjust the number of allowed call retries for specific campaigns. - Modify tags assigned to campaigns to enhance your tracking. - Manage numbers associated with campaigns, including: adding, updating, or removing them. - Extend the capabilities of your campaigns by adding custom columns (enriched data). **Permissions:** No specific permission required. A valid API key is sufficient to access all campaign routes. **Monitoring impact:** None.

GitHub OpenAPI

Operations 28

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /campaigns/call List all outbound call campaigns · List all outbound call campaigns #
Ask an LLM
“Which outbound call campaigns are configured for my team?”
“Can I list only the campaigns that are currently running?”
Tell an agent
List all outbound call campaigns.
List call campaigns where is_running is {is_running}.
GET /campaigns/call/user List call campaigns assigned to me · List active campaigns assigned to the current user #
Ask an LLM
“Which outbound call campaigns are assigned to the user behind my API key?”
“What campaigns do I need to work on right now?”
Tell an agent
List the active call campaigns assigned to the current user.
Show my call campaigns, {limit_count} per page.
GET /campaigns/call/{campaignscalllistuuid} Get an outbound call campaign · Get a specific campaign by UUID #
Ask an LLM
“What are the full settings of a specific outbound call campaign?”
“Can I see the contact queue progress for one campaign?”
Tell an agent
Get call campaign {campaignscalllistuuid}.
Show the full configuration of campaign {campaignscalllistuuid}.
PATCH /campaigns/call/{campaignscalllistuuid}/start Start an outbound call campaign · Start a campaign #
Ask an LLM
“How do I start an outbound call campaign so it begins calling contacts?”
“Can I schedule a campaign to start at a later date?”
Tell an agent
Start call campaign {campaignscalllistuuid}.
Start campaign {campaignscalllistuuid} on {start_date}.
PATCH /campaigns/call/{campaignscalllistuuid}/start/edit Reschedule a campaign's start date · Edit a campaign's scheduled start date #
Ask an LLM
“Can I change the scheduled start time of a campaign that hasn't started yet?”
“How do I reschedule a campaign without restarting it?”
Tell an agent
Reschedule the start of campaign {campaignscalllistuuid} to {start_date}.
Edit the scheduled start date of call campaign {campaignscalllistuuid}.
PATCH /campaigns/call/{campaignscalllistuuid}/stop Stop a running call campaign · Stop a running campaign #
Ask an LLM
“How do I stop an outbound call campaign that is still running?”
“Do calls already in progress get interrupted when I stop a campaign?”
Tell an agent
Stop call campaign {campaignscalllistuuid}.
Pause campaign {campaignscalllistuuid} so it stops calling new contacts.
POST /campaigns/call/{campaignscalllistuuid}/reset Reset a call campaign to its initial state · Reset a campaign to its initial state #
Ask an LLM
“Can I clear all call statistics on a campaign and start over from scratch?”
“What happens to contacts that haven't been called yet when I reset a campaign?”
Tell an agent destructive · confirm first
Reset call campaign {campaignscalllistuuid} to its initial state.
Clear call statistics on campaign {campaignscalllistuuid} and reset retry counts.
GET /campaigns/call/{campaignscalllistuuid}/numbers List contacts in a call campaign's queue · List contacts in a campaign's call queue #
Ask an LLM
“Which phone numbers are still in the queue of a call campaign?”
“Can I see the call status and retry count for each contact in a campaign?”
Tell an agent
List the contacts in call campaign {campaignscalllistuuid}'s queue.
Show {limit_count} queued contacts for campaign {campaignscalllistuuid}.
POST /campaigns/call/{campaignscalllistuuid}/numbers Add contacts to a call campaign's queue · Add contacts to a campaign's call queue #
Ask an LLM
“How do I add new phone numbers to an outbound call campaign?”
“Can I add contacts with custom fields to a campaign's queue?”
Tell an agent
Add contacts {to_numbers} to call campaign {campaignscalllistuuid}.
Bulk add new numbers to the queue of campaign {campaignscalllistuuid}.
DELETE /campaigns/call/{campaignscalllistuuid}/numbers Remove contacts from a call campaign's queue · Remove contacts from a campaign's call queue #
Ask an LLM
“How do I remove phone numbers from a call campaign's queue?”
“Can I take a number out of a campaign without deleting the contact?”
Tell an agent destructive · confirm first
Remove contacts {to_numbers} from call campaign {campaignscalllistuuid}'s queue.
Delete numbers {to_numbers} from campaign {campaignscalllistuuid}.
PATCH /campaigns/call/{campaignscalllistuuid}/numbers Update metadata for call campaign contacts · Update metadata for campaign contacts #
Ask an LLM
“Can I change the first name or company on contacts already in a call campaign?”
“How do I edit the metadata of numbers in a campaign's queue?”
Tell an agent
Update the metadata of contacts {to_numbers} in call campaign {campaignscalllistuuid}.
Edit contact information for {to_numbers} in campaign {campaignscalllistuuid}.
POST /campaigns/call/{campaignscalllistuuid}/numbers/columns Add a custom column to call campaign contacts · Add a custom data column to campaign contacts #
Ask an LLM
“How do I add a new custom field to every contact in a call campaign?”
“Can I give a default value when adding a column to campaign contacts?”
Tell an agent
Add a custom column {name} to all contacts in call campaign {campaignscalllistuuid}.
Add column {name} to campaign {campaignscalllistuuid} contacts with values {numbers_data}.
DELETE /campaigns/call/{campaignscalllistuuid}/numbers/columns Delete a custom column from call campaign contacts · Delete a custom data column from campaign contacts #
Ask an LLM
“How do I remove a custom column from every contact in a call campaign?”
“Can I delete a column that was added to campaign contacts?”
Tell an agent destructive · confirm first
Delete column {name} from all contacts in call campaign {campaignscalllistuuid}.
Remove the {name} column from campaign {campaignscalllistuuid} contacts.
PATCH /campaigns/call/{campaignscalllistuuid}/numbers/columns/rename Rename a custom column in call campaign contacts · Rename a custom data column in campaign contacts #
Ask an LLM
“Can I rename a custom column on contacts in a call campaign?”
“What happens to existing values when I rename a campaign contact column?”
Tell an agent
Rename column {old_name} to {new_name} in call campaign {campaignscalllistuuid} contacts.
Change the name of the {old_name} column in campaign {campaignscalllistuuid} contacts.
PATCH /campaigns/call/{campaignscalllistuuid}/numbers/columns/switch Swap the position of two custom columns · Swap the position of two custom columns #
Ask an LLM
“Can I change which custom column appears first on contacts in a call campaign?”
“How do I reorder two columns in a campaign's contact data?”
Tell an agent
Swap the positions of columns {column1} and {column2} in call campaign {campaignscalllistuuid} contacts.
Move column {column1} before column {column2} in campaign {campaignscalllistuuid} contacts.
PATCH /campaigns/call/{campaignscalllistuuid}/name/{newname} Rename a call campaign · Rename a campaign #
Ask an LLM
“How do I change the display name of an outbound call campaign?”
“Can I rename a campaign without touching its contacts or settings?”
Tell an agent
Rename call campaign {campaignscalllistuuid} to {newname}.
Change the name of campaign {campaignscalllistuuid} to {newname}.
PATCH /campaigns/call/{campaignscalllistuuid}/maxretry/{newMaxRetry} Change a campaign's maximum retry attempts · Update maximum retry attempts #
Ask an LLM
“How do I make a campaign retry each contact more times?”
“Can I reset all contacts' retry counters when I change the max retry limit?”
Tell an agent
Set the maximum retry attempts on call campaign {campaignscalllistuuid} to {newMaxRetry}.
Change campaign {campaignscalllistuuid} max retry to {newMaxRetry}.
GET /campaigns/call/{campaignscalllistuuid}/groups List groups assigned to a call campaign · List groups assigned to a campaign #
Ask an LLM
“Which call groups are assigned to a specific campaign?”
“How are contacts in a campaign distributed to agents?”
Tell an agent
List the groups assigned to call campaign {campaignscalllistuuid}.
Show which call groups campaign {campaignscalllistuuid} sends contacts to.
POST /campaigns/call/{campaignscalllistuuid}/groups Assign groups to a call campaign · Assign groups to a campaign #
Ask an LLM
“How do I assign call groups to a campaign so agents can receive its calls?”
“Can I add several groups to a campaign at once?”
Tell an agent
Assign groups {to_groups} to call campaign {campaignscalllistuuid}.
Add call groups {to_groups} to campaign {campaignscalllistuuid}.
DELETE /campaigns/call/{campaignscalllistuuid}/groups Remove groups from a call campaign · Remove groups from a campaign #
Ask an LLM
“How do I stop certain call groups from receiving a campaign's calls?”
“Can I remove a group from a campaign without deleting the group itself?”
Tell an agent destructive · confirm first
Remove groups {to_groups} from call campaign {campaignscalllistuuid}.
Take call groups {to_groups} off campaign {campaignscalllistuuid}.
GET /campaigns/call/{campaignscalllistuuid}/users List users assigned to a call campaign · List users assigned to a campaign #
Ask an LLM
“Which individual users are assigned to a call campaign, not just through groups?”
“Can I page through a campaign's direct user assignments?”
Tell an agent
List users directly assigned to call campaign {campaign}.
Show {count} users assigned to campaign {campaign}, skipping {offset}.
POST /campaigns/call/{campaignscalllistuuid}/users Assign individual users to a call campaign · Assign individual users to a campaign #
Ask an LLM
“How do I add specific agents to a call campaign?”
“Can I assign several users to a campaign at once?”
Tell an agent
Assign users {to_Users} to call campaign {campaign}.
Add {to_Users} as direct agents on campaign {campaign}.
DELETE /campaigns/call/{campaignscalllistuuid}/users Remove individual users from a call campaign · Remove users from a campaign #
Ask an LLM
“How do I take agents off a call campaign?”
“Can I remove several users from a campaign at once?”
Tell an agent destructive · confirm first
Remove users {to_Users} from call campaign {campaign}.
Take {to_Users} off campaign {campaign} so they stop getting calls.
PUT /campaigns/call/{campaignscalllistuuid}/tags Replace all tags on a call campaign · Replace all tags on a campaign #
Ask an LLM
“How do I set the exact tag set on a call campaign?”
“Does replacing a campaign's tags remove tags I leave out?”
Tell an agent
Replace all tags on call campaign {campaign} with {tags}.
Set the tag list of campaign {campaign} to {tags}.
DELETE /campaigns/call/{campaignscalllistuuid}/tags Remove all tags from a call campaign · Remove all tags from a campaign #
Ask an LLM
“How do I clear every tag from a call campaign?”
“Can I remove all tags from a campaign in one call?”
Tell an agent destructive · confirm first
Remove all tags from call campaign {campaign}.
Clear every tag on campaign {campaign}.
DELETE /campaigns/call/{campaignscalllistuuid}/tags/{tagID} Remove one tag from a call campaign · Remove a specific tag from a campaign #
Ask an LLM
“How do I take a single tag off a call campaign?”
“Can I keep other tags while removing one from a campaign?”
Tell an agent destructive · confirm first
Remove tag {tagID} from call campaign {campaign}.
Keep campaign {campaign} but drop tag {tagID}.
PUT /campaigns/call/{campaignscalllistuuid}/script Assign or remove a call script · Assign or remove a call script #
Ask an LLM
“How do I give agents a call script during a campaign?”
“Can I remove the script from a campaign?”
Tell an agent
Assign call script {script_uuid} to campaign {campaign}.
Remove the call script from campaign {campaign}.
GET /campaigns/call/{campaignscalllistuuid}/logs Get a call campaign's audit log · Get campaign audit logs #
Ask an LLM
“Who started, stopped or reset a call campaign?”
“Can I audit changes made to a campaign?”
Tell an agent
Show the audit log for call campaign {campaign}.
List every change made to campaign {campaign}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/ringover:ringover-campaigns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ringover-campaigns-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  license:
    name: Proprietary – Contact us for usage terms
    url: https://www.ringover.com/contact
  description: '# Ringover Public API


    Welcome to the Ringover Public API. This RESTful API lets you integrate Ringover telephony, messaging, contacts, and AI analytics into your applications. ## Base URL


    | Region | Base URL |

    |--------|----------|

    | Europe | `https://public-api.ringover.com/v2` |

    | United States | `https://public-api-us.ringover.com/v2` |


    ## Authentication


    All requests must include your API key in the `Authorization` header:


    ```

    Authorization: your-api-key-here

    ```


    To create an API key:

    1. Open the Ringover Dashboard. 2. Navigate to **Developer > API Keys**. 3. Click **Create an API key**, select a user, and set a label. 4. Configure the permissions for this key (see Permissions below). ## Permissions


    Each API key is associated with **7 permission categories**, each configurable as **None**, **Read**, **Write**, or **Read+Write**:


    | Category | Controls access to |

    |----------|-------------------|

    | **Calls** | Call history, archives, live call controls, callbacks |

    | **Contacts** | Contact CRUD and phone number management |

    | **Users** | User listing, plannings, presences, groups, user blacklists |

    | **Numbers** | Phone number listing, team blacklist |

    | **IVRs** | IVR/scenario listing, tag management |

    | **Conversations** | SMS/Chat conversations, messages, SMS sending |

    | **Empower** | AI call analysis, summaries, moments, analytics |


    ### The Monitoring flag (Supervision)


    In addition to R/W permissions, each API key has a **Monitoring** toggle that controls the **scope** of data returned:


    | Monitoring | Effect |

    |------------|--------|

    | **OFF** | Your permissions give access to **your own data only** (your calls, your numbers, your conversations…) |

    | **ON** | Your permissions give access to **the entire team''s data** (all users, all calls, all conversations…) |


    Monitoring does **not** grant additional permissions — it widens the scope of existing ones. Some routes **require** Monitoring to be enabled and will return `401` without it. Conversely, some routes may ignore the Monitoring flag entirely or apply it differently — unless stated otherwise in the endpoint documentation, the default behavior described above applies. > Each endpoint in this documentation specifies its exact permission and monitoring requirements. ### Special cases


    - **Campaigns, Tasks, WhatsApp**: These routes do not require specific token permissions. A valid API key is sufficient. - **Empower**: Uses its own role system (Admin / Supervisor / User) in addition to the Empower R/W permission. - **Transcriptions**: Access is controlled by a team-level setting, not by the token permissions. - **Conferences**: All conference routes require Monitoring enabled. ## Rate Limiting


    A **2-request-per-second** rate limit is applied per API key. Exceeding this limit returns `429 Too Many Requests`. ## Pagination


    List endpoints support offset-based pagination with two parameters:

    - `limit_count`: Maximum number of items to return (default: 100, max varies by endpoint). - `limit_offset`: Number of items to skip (default: 0). Some call-related endpoints also support cursor-based pagination via `last_id_returned`. ## Error Responses


    | HTTP Code | Meaning |

    |-----------|---------|

    | `400` | Bad request — invalid parameters or body |

    | `401` | Unauthorized — invalid/expired API key, or access denied by permission/monitoring checks on most endpoints |

    | `403` | Forbidden — authenticated request refused by specific endpoint logic (notably some Empower routes) or upstream forwarded services |

    | `402` | Payment required — feature not available on your plan |

    | `404` | Resource not found |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |


    ## SCIM 2.0 Provisioning


    Ringover exposes a **SCIM 2.0** server (RFC 7643 / RFC 7644) for automated user and group provisioning from your identity provider (Okta, Microsoft Entra ID, …). It reuses the **same API key** as the REST API (`Authorization` header).'
  version: 2.1.0
  title: Ringover Public Campaigns API
  x-logo:
    url: https://webcdn.ringover.com/app/img/misc/logo_app_redoc.png
    backgroundColor: '#FAFAFA'
    altText: Ringover Logo
  termsOfService: https://ringover.com/terms/
  contact:
    email: support@ringover.com
servers:
- url: https://public-api.ringover.com/v2
  description: Production server (Europe)
- url: https://public-api-us.ringover.com/v2
  description: Production server (United States)
security:
- Authorization: []
tags:


# --- truncated at 32 KB (71 KB total) ---
# Full source: https://artifacts.apis.io/ringover/openapi/ringover-campaigns-api-openapi.yml