Genesys

Genesys Outbound API

The Outbound API from Genesys — 102 operation(s) for outbound.

GitHub OpenAPI

Operations 176

PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId} Send notification that an agent's state changed #
GET /api/v2/outbound/attemptlimits/{attemptLimitsId} Get attempt limits #
PUT /api/v2/outbound/attemptlimits/{attemptLimitsId} Update attempt limits #
DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId} Delete attempt limits #
GET /api/v2/outbound/attemptlimits Query attempt limits list #
POST /api/v2/outbound/attemptlimits Create attempt limits #
GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Get a dialer call analysis response set #
PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Update a dialer call analysis response set #
DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Delete a dialer call analysis response set #
GET /api/v2/outbound/callanalysisresponsesets Query a list of dialer call analysis response sets #
POST /api/v2/outbound/callanalysisresponsesets Create a dialer call analysis response set #
GET /api/v2/outbound/callabletimesets/{callableTimeSetId} Get callable time set #
PUT /api/v2/outbound/callabletimesets/{callableTimeSetId} Update callable time set #
DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId} Delete callable time set #
GET /api/v2/outbound/callabletimesets Query callable time set list #
POST /api/v2/outbound/callabletimesets Create callable time set #
POST /api/v2/outbound/campaigns/{campaignId}/callback/schedule Schedule a Callback for a Dialer Campaign (Deprecated) #
GET /api/v2/outbound/campaigns/divisionviews/{campaignId} Get a basic Campaign information object #
GET /api/v2/outbound/campaigns/divisionviews Query a list of basic Campaign information objects #
GET /api/v2/outbound/campaigns/{campaignId}/interactions Get dialer campaign interactions #
GET /api/v2/outbound/campaigns/{campaignId}/linedistribution Get line distribution information for campaigns using same Edge Group or Site… #
GET /api/v2/outbound/campaigns/{campaignId} Get dialer campaign #
PUT /api/v2/outbound/campaigns/{campaignId} Update a campaign #
DELETE /api/v2/outbound/campaigns/{campaignId} Delete a campaign #
PATCH /api/v2/outbound/campaigns/{campaignId} Update a campaign #
GET /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results Get a preview of how agents will be mapped to this campaign's contact list #
POST /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview Initiate request for a preview of how agents will be mapped to this campaign's… #
GET /api/v2/outbound/campaigns/{campaignId}/diagnostics Get campaign diagnostics #
GET /api/v2/outbound/campaigns/{campaignId}/progress Get campaign progress #
DELETE /api/v2/outbound/campaigns/{campaignId}/progress Reset campaign progress and recycle the campaign #
GET /api/v2/outbound/campaigns/{campaignId}/skillcombinations Get the remaining and total contact count for each skill combination in a… #
POST /api/v2/outbound/campaigns/{campaignId}/start Start the campaign #
POST /api/v2/outbound/campaigns/{campaignId}/stop Stop the campaign #
GET /api/v2/outbound/campaignrules/{campaignRuleId} Get Campaign Rule #
PUT /api/v2/outbound/campaignrules/{campaignRuleId} Update Campaign Rule #
DELETE /api/v2/outbound/campaignrules/{campaignRuleId} Delete Campaign Rule #
GET /api/v2/outbound/campaignrules Query Campaign Rule list #
POST /api/v2/outbound/campaignrules Create Campaign Rule #
GET /api/v2/outbound/schedules/campaigns/{campaignId} Get a dialer campaign schedule #
PUT /api/v2/outbound/schedules/campaigns/{campaignId} Update a new campaign schedule #
DELETE /api/v2/outbound/schedules/campaigns/{campaignId} Delete a dialer campaign schedule #
GET /api/v2/outbound/schedules/campaigns Query for a list of dialer campaign schedules #
GET /api/v2/outbound/campaigns/{campaignId}/stats Get statistics about a Dialer Campaign #
POST /api/v2/outbound/campaigns/performance/query Get performance data for a list of campaigns #
POST /api/v2/outbound/campaigns/progress Get progress for a list of campaigns #
GET /api/v2/outbound/campaigns Query a list of dialer campaigns #
POST /api/v2/outbound/campaigns Create a campaign #
GET /api/v2/outbound/campaigns/all/divisionviews Query across all types of campaigns #
GET /api/v2/outbound/campaigns/all Query across all types of campaigns by division #
GET /api/v2/outbound/contactlists/divisionviews/{contactListId} Get a basic ContactList information object #
GET /api/v2/outbound/contactlists/divisionviews Query a list of simplified contact list objects #
GET /api/v2/outbound/contactlists/{contactListId}/export Get the URI of a contact list export #
POST /api/v2/outbound/contactlists/{contactListId}/export Initiate the export of a contact list #
POST /api/v2/outbound/contactlistfilters/preview Get a preview of the output of a contact list filter #
GET /api/v2/outbound/contactlistfilters/{contactListFilterId} Get Contact list filter #
PUT /api/v2/outbound/contactlistfilters/{contactListFilterId} Update Contact List Filter #
DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId} Delete Contact List Filter #
POST /api/v2/outbound/contactlistfilters/bulk/retrieve Retrieve multiple contact list filters #
GET /api/v2/outbound/contactlistfilters Query Contact list filters #
POST /api/v2/outbound/contactlistfilters Create Contact List Filter #
GET /api/v2/outbound/contactlists/{contactListId}/importstatus Get dialer contactList import status #
GET /api/v2/outbound/contactlists/{contactListId} Get a dialer contact list #
PUT /api/v2/outbound/contactlists/{contactListId} Update a contact list #
DELETE /api/v2/outbound/contactlists/{contactListId} Delete a contact list #
GET /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview Preview the result of applying Automatic Time Zone Mapping to a contact list #
GET /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Get Contact List Template #
PUT /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Update a contact list template #
DELETE /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Delete Contact List Template #
GET /api/v2/outbound/contactlisttemplates Query a list of contact list templates #
POST /api/v2/outbound/contactlisttemplates Create Contact List Template #
DELETE /api/v2/outbound/contactlisttemplates Delete multiple contact list templates #
POST /api/v2/outbound/contactlisttemplates/bulk/add Add multiple contact list templates #
POST /api/v2/outbound/contactlisttemplates/bulk/retrieve Get multiple contact list templates #
GET /api/v2/outbound/contactlists Query a list of contact lists #
POST /api/v2/outbound/contactlists Create a contact List #
DELETE /api/v2/outbound/contactlists Delete multiple contact lists #
POST /api/v2/outbound/contactlists/uploads Generate presigned upload URL for contact list #
GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Get a contact #
PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Update a contact #
DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Delete a contact #
POST /api/v2/outbound/contactlists/{contactListId}/clear Deletes all contacts out of a list. #
GET /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId} Get bulk operation job #
GET /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs Get 10 most recent bulk operation jobs associated with contact list #
POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk Get contacts from a contact list #
POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove Start an async job to delete contacts using a filter #
POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update Start an async job to bulk edit contacts #
POST /api/v2/outbound/contactlists/{contactListId}/contacts/search Query contacts from a contact list #
POST /api/v2/outbound/contactlists/{contactListId}/contacts Add contacts to a contact list #
DELETE /api/v2/outbound/contactlists/{contactListId}/contacts Delete contacts from a contact list. #
POST /api/v2/outbound/dnclists/uploads Generate presigned upload URL for dnc list #
POST /api/v2/outbound/conversations/{conversationId}/dnc Add phone numbers to a Dialer DNC list #
DELETE /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns Deletes all or expired custom exclusion column entries from a DNC list #
PATCH /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns Add entries to or delete entries from a DNC list #
GET /api/v2/outbound/dnclists/divisionviews/{dncListId} Get a basic DncList information object #
GET /api/v2/outbound/dnclists/divisionviews Query a list of simplified dnc list objects #
POST /api/v2/outbound/dnclists/{dncListId}/emailaddresses Add email addresses to a DNC list #
DELETE /api/v2/outbound/dnclists/{dncListId}/emailaddresses Deletes all or expired email addresses from a DNC list #
PATCH /api/v2/outbound/dnclists/{dncListId}/emailaddresses Add emails to or Delete emails from a DNC list #
GET /api/v2/outbound/dnclists/{dncListId}/export Get the URI of a DNC list export #
POST /api/v2/outbound/dnclists/{dncListId}/export Initiate the export of a dnc list #
GET /api/v2/outbound/dnclists/{dncListId}/importstatus Get dialer dncList import status #
POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers Add phone numbers to a DNC list #
DELETE /api/v2/outbound/dnclists/{dncListId}/phonenumbers Deletes all or expired phone numbers from a DNC list #
PATCH /api/v2/outbound/dnclists/{dncListId}/phonenumbers Add numbers to or delete numbers from a DNC list #
GET /api/v2/outbound/dnclists/{dncListId} Get dialer DNC list #
PUT /api/v2/outbound/dnclists/{dncListId} Update dialer DNC list #
DELETE /api/v2/outbound/dnclists/{dncListId} Delete dialer DNC list #
DELETE /api/v2/outbound/dnclists/{dncListId}/whatsappnumbers Deletes all or expired whatsApp numbers from a DNC list #
PATCH /api/v2/outbound/dnclists/{dncListId}/whatsappnumbers Add entries to or delete entries from a DNC list #
GET /api/v2/outbound/dnclists Query dialer DNC lists #
POST /api/v2/outbound/dnclists Create dialer DNC list #
GET /api/v2/outbound/events/{eventId} Get Dialer Event #
GET /api/v2/outbound/events Query Event Logs #
DELETE /api/v2/outbound/filespecificationtemplates/bulk Delete multiple file specification templates #
GET /api/v2/outbound/filespecificationtemplates Query File Specification Templates #
POST /api/v2/outbound/filespecificationtemplates Create File Specification Template #
GET /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId} Get File Specification Template #
PUT /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId} Update File Specification Template #
DELETE /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId} Delete File Specification Template #
GET /api/v2/outbound/importtemplates/{importTemplateId}/importstatus Get the import status for an import template #
GET /api/v2/outbound/importtemplates/{importTemplateId} Get Import Template #
PUT /api/v2/outbound/importtemplates/{importTemplateId} Update Import Template #
DELETE /api/v2/outbound/importtemplates/{importTemplateId} Delete Import Template #
GET /api/v2/outbound/importtemplates Query Import Templates #
POST /api/v2/outbound/importtemplates Create Import Template #
DELETE /api/v2/outbound/importtemplates Delete multiple import templates #
POST /api/v2/outbound/importtemplates/bulk/add Add multiple import templates #
POST /api/v2/outbound/messagingcampaigns/progress Get progress for a list of messaging campaigns #
GET /api/v2/outbound/settings Get the outbound settings for this organization #
PATCH /api/v2/outbound/settings Update the outbound settings for this organization #
GET /api/v2/outbound/rulesets/{ruleSetId} Get a Rule Set by ID #
PUT /api/v2/outbound/rulesets/{ruleSetId} Update a Rule Set #
DELETE /api/v2/outbound/rulesets/{ruleSetId} Delete a Rule Set #
GET /api/v2/outbound/rulesets Query a list of Rule Sets #
POST /api/v2/outbound/rulesets Create a Rule Set #
GET /api/v2/outbound/sequences/{sequenceId} Get a dialer campaign sequence #
PUT /api/v2/outbound/sequences/{sequenceId} Update a new campaign sequence #
DELETE /api/v2/outbound/sequences/{sequenceId} Delete a dialer campaign sequence #
GET /api/v2/outbound/schedules/sequences/{sequenceId} Get a dialer sequence schedule #
PUT /api/v2/outbound/schedules/sequences/{sequenceId} Update a new sequence schedule #
DELETE /api/v2/outbound/schedules/sequences/{sequenceId} Delete a dialer sequence schedule #
GET /api/v2/outbound/schedules/sequences Query for a list of dialer sequence schedules #
GET /api/v2/outbound/sequences Query a list of dialer campaign sequences #
POST /api/v2/outbound/sequences Create a new campaign sequence #
GET /api/v2/outbound/wrapupcodemappings Get the Dialer wrap up code mapping #
PUT /api/v2/outbound/wrapupcodemappings Update the Dialer wrap up code mapping #
GET /api/v2/outbound/diagnostics/campaigns/{campaignId}/summary Get diagnostic summary for a single campaign #
GET /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Get an Outbound Digital Rule Set #
PUT /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Update an Outbound Digital Rule Set #
DELETE /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Delete an Outbound Digital Rule Set #
GET /api/v2/outbound/digitalrulesets Query a list of Outbound Digital Rule Sets #
POST /api/v2/outbound/digitalrulesets Create an Outbound Digital Rule Set #
GET /api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId} Get a basic Messaging Campaign information object #
GET /api/v2/outbound/messagingcampaigns/divisionviews Query a list of basic Messaging Campaign information objects #
GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId} Get an Outbound Messaging Campaign #
PUT /api/v2/outbound/messagingcampaigns/{messagingCampaignId} Update an Outbound Messaging Campaign #
DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId} Delete an Outbound Messaging Campaign #
GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress Get messaging campaign's progress #
DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress Reset messaging campaign progress and recycle the messaging campaign #
GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics Get messaging campaign diagnostics #
POST /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start Start the campaign #
POST /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop Stop the campaign #
GET /api/v2/outbound/messagingcampaigns Query a list of Messaging Campaigns #
POST /api/v2/outbound/messagingcampaigns Create a Messaging Campaign #
GET /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId} Get an email campaign schedule #
PUT /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId} Update an email campaign schedule #
DELETE /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId} Delete an email campaign schedule #
GET /api/v2/outbound/schedules/emailcampaigns Query for a list of email campaign schedules #
GET /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId} Get a messaging campaign schedule #
PUT /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId} Update a new messaging campaign schedule #
DELETE /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId} Delete a messaging campaign schedule #
GET /api/v2/outbound/schedules/messagingcampaigns Query for a list of messaging campaign schedules #
GET /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId} Get a WhatsApp campaign schedule #
PUT /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId} Update a WhatsApp campaign schedule #
DELETE /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId} Delete a WhatsApp campaign schedule #
GET /api/v2/outbound/schedules/whatsappcampaigns Query for a list of WhatsApp campaign schedules #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-outbound-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

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/genesys:genesys-outbound-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

genesys-outbound-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Outbound API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (1795 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-outbound-api-openapi.yml