How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Genesys Outbound API

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

Genesys Outbound API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Outbound. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 176 operations across 102 paths, and defines 368 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

176 operations 102 paths 368 schemas 32 DELETE73 GET6 PATCH42 POST23 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Outbound API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 176

Across 102 paths, the API surfaces 176 operations — 32 DELETE, 73 GET, 6 PATCH, 42 POST, 23 PUT. Each is listed below with its method, path, parameters, and response codes.

Outbound 176
PUT
/api/v2/outbound/campaigns/{campaignId}/agents/{userId}
Send notification that an agent's state changed
putOutboundCampaignAgent 3 params → 200400401403404408409413
GET
/api/v2/outbound/attemptlimits/{attemptLimitsId}
Get attempt limits
getOutboundAttemptlimit 1 param → 200400401403404408409413
PUT
/api/v2/outbound/attemptlimits/{attemptLimitsId}
Update attempt limits
putOutboundAttemptlimit 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/attemptlimits/{attemptLimitsId}
Delete attempt limits
deleteOutboundAttemptlimit 1 param → 200400401403404408409413
GET
/api/v2/outbound/attemptlimits
Query attempt limits list
getOutboundAttemptlimits 7 params → 200400401403404408409413
POST
/api/v2/outbound/attemptlimits
Create attempt limits
postOutboundAttemptlimits 1 param → 200400401403404408409413
GET
/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
Get a dialer call analysis response set.
getOutboundCallanalysisresponseset 1 param → 200400401403404408409413
PUT
/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
Update a dialer call analysis response set.
putOutboundCallanalysisresponseset 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
Delete a dialer call analysis response set.
deleteOutboundCallanalysisresponseset 1 param → 200400401403404408409413
GET
/api/v2/outbound/callanalysisresponsesets
Query a list of dialer call analysis response sets.
getOutboundCallanalysisresponsesets 7 params → 200400401403404408409413
POST
/api/v2/outbound/callanalysisresponsesets
Create a dialer call analysis response set.
postOutboundCallanalysisresponsesets 1 param → 200400401403404408409413
GET
/api/v2/outbound/callabletimesets/{callableTimeSetId}
Get callable time set
getOutboundCallabletimeset 1 param → 200400401403404408409413
PUT
/api/v2/outbound/callabletimesets/{callableTimeSetId}
Update callable time set
putOutboundCallabletimeset 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/callabletimesets/{callableTimeSetId}
Delete callable time set
deleteOutboundCallabletimeset 1 param → 200400401403404408409413
GET
/api/v2/outbound/callabletimesets
Query callable time set list
getOutboundCallabletimesets 7 params → 200400401403404408409413
POST
/api/v2/outbound/callabletimesets
Create callable time set
postOutboundCallabletimesets 1 param → 200400401403404408409413
POST
/api/v2/outbound/campaigns/{campaignId}/callback/scheduledeprecated
Schedule a Callback for a Dialer Campaign (Deprecated)
postOutboundCampaignCallbackSchedule 2 params → 200400401403404408409413
GET
/api/v2/outbound/campaigns/divisionviews/{campaignId}
Get a basic Campaign information object
getOutboundCampaignsDivisionview 1 param → 200400401403404408409413
GET
/api/v2/outbound/campaigns/divisionviews
Query a list of basic Campaign information objects
getOutboundCampaignsDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/outbound/campaigns/{campaignId}/interactions
Get dialer campaign interactions.
getOutboundCampaignInteractions 1 param → 200400401403404408409413
GET
/api/v2/outbound/campaigns/{campaignId}/linedistribution
Get line distribution information for campaigns using same Edge Group or Site as given campaign
getOutboundCampaignLinedistribution 7 params → 200400401403404408409413
GET
/api/v2/outbound/campaigns/{campaignId}
Get dialer campaign.
getOutboundCampaign 1 param → 200400401403404408409413
PUT
/api/v2/outbound/campaigns/{campaignId}
Update a campaign.
putOutboundCampaign 3 params → 200409400401403404408413
DELETE
/api/v2/outbound/campaigns/{campaignId}
Delete a campaign.
deleteOutboundCampaign 1 param → 200400401403404408409413
PATCH
/api/v2/outbound/campaigns/{campaignId}
Update a campaign.
patchOutboundCampaign 2 params → 204400401403404408409413
GET
/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results
Get a preview of how agents will be mapped to this campaign's contact list.
getOutboundCampaignAgentownedmappingpreviewResults 1 param → 200202400401403404408409
POST
/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview
Initiate request for a preview of how agents will be mapped to this campaign's contact list.
postOutboundCampaignAgentownedmappingpreview 1 param → 200202400401403404408409
GET
/api/v2/outbound/campaigns/{campaignId}/diagnostics
Get campaign diagnostics
getOutboundCampaignDiagnostics 1 param → 200400401403404408409413
GET
/api/v2/outbound/campaigns/{campaignId}/progress
Get campaign progress
getOutboundCampaignProgress 1 param → 200400401403404408409413
DELETE
/api/v2/outbound/campaigns/{campaignId}/progress
Reset campaign progress and recycle the campaign
deleteOutboundCampaignProgress 1 param → 202400401403404408409413
GET
/api/v2/outbound/campaigns/{campaignId}/skillcombinations
Get the remaining and total contact count for each skill combination in a skills campaign
getOutboundCampaignSkillcombinations 3 params → 200400401403404408409413
POST
/api/v2/outbound/campaigns/{campaignId}/start
Start the campaign
postOutboundCampaignStart 1 param → 204400401403404408409413
POST
/api/v2/outbound/campaigns/{campaignId}/stop
Stop the campaign
postOutboundCampaignStop 1 param → 204400401403404408409413
GET
/api/v2/outbound/campaignrules/{campaignRuleId}
Get Campaign Rule
getOutboundCampaignrule 1 param → 200400401403404408409413
PUT
/api/v2/outbound/campaignrules/{campaignRuleId}
Update Campaign Rule
putOutboundCampaignrule 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/campaignrules/{campaignRuleId}
Delete Campaign Rule
deleteOutboundCampaignrule 1 param → 200400401403404408409413
GET
/api/v2/outbound/campaignrules
Query Campaign Rule list
getOutboundCampaignrules 7 params → 200400401403404408409413
POST
/api/v2/outbound/campaignrules
Create Campaign Rule
postOutboundCampaignrules 1 param → 200400401403404408409413
GET
/api/v2/outbound/schedules/campaigns/{campaignId}
Get a dialer campaign schedule.
getOutboundSchedulesCampaign 1 param → 200400401403404408409413
PUT
/api/v2/outbound/schedules/campaigns/{campaignId}
Update a new campaign schedule.
putOutboundSchedulesCampaign 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/schedules/campaigns/{campaignId}
Delete a dialer campaign schedule.
deleteOutboundSchedulesCampaign 1 param → 200400401403404408409413
GET
/api/v2/outbound/schedules/campaigns
Query for a list of dialer campaign schedules.
getOutboundSchedulesCampaigns → 200400401403404408409413
GET
/api/v2/outbound/campaigns/{campaignId}/stats
Get statistics about a Dialer Campaign
getOutboundCampaignStats 1 param → 200400401403404408409413
POST
/api/v2/outbound/campaigns/performance/query
Get performance data for a list of campaigns
postOutboundCampaignsPerformanceQuery 1 param → 200400401403404408409413
POST
/api/v2/outbound/campaigns/progress
Get progress for a list of campaigns
postOutboundCampaignsProgress 1 param → 200400401403404408409413
GET
/api/v2/outbound/campaigns
Query a list of dialer campaigns.
getOutboundCampaigns 13 params → 200400401403404408409413
POST
/api/v2/outbound/campaigns
Create a campaign.
postOutboundCampaigns 2 params → 200400401403404408409413
GET
/api/v2/outbound/campaigns/all/divisionviews
Query across all types of campaigns
getOutboundCampaignsAllDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/outbound/campaigns/all
Query across all types of campaigns by division
getOutboundCampaignsAll 7 params → 200400401403404408409413
GET
/api/v2/outbound/contactlists/divisionviews/{contactListId}
Get a basic ContactList information object
getOutboundContactlistsDivisionview 3 params → 200400401403404408409413
GET
/api/v2/outbound/contactlists/divisionviews
Query a list of simplified contact list objects.
getOutboundContactlistsDivisionviews 9 params → 200400401403404408409413
GET
/api/v2/outbound/contactlists/{contactListId}/export
Get the URI of a contact list export.
getOutboundContactlistExport 2 params → 200400401403404408409413
POST
/api/v2/outbound/contactlists/{contactListId}/export
Initiate the export of a contact list.
postOutboundContactlistExport 2 params → 200400401403404408409413
POST
/api/v2/outbound/contactlistfilters/preview
Get a preview of the output of a contact list filter
postOutboundContactlistfiltersPreview 1 param → 200400401403404408409413
GET
/api/v2/outbound/contactlistfilters/{contactListFilterId}
Get Contact list filter
getOutboundContactlistfilter 1 param → 200400401403404408409413
PUT
/api/v2/outbound/contactlistfilters/{contactListFilterId}
Update Contact List Filter
putOutboundContactlistfilter 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/contactlistfilters/{contactListFilterId}
Delete Contact List Filter
deleteOutboundContactlistfilter 1 param → 204400401403404408409413
POST
/api/v2/outbound/contactlistfilters/bulk/retrieve
Retrieve multiple contact list filters
postOutboundContactlistfiltersBulkRetrieve 1 param → 200400401403404408409413
GET
/api/v2/outbound/contactlistfilters
Query Contact list filters
getOutboundContactlistfilters 8 params → 200400401403404408409413
POST
/api/v2/outbound/contactlistfilters
Create Contact List Filter
postOutboundContactlistfilters 1 param → 200400401403404408409413
GET
/api/v2/outbound/contactlists/{contactListId}/importstatus
Get dialer contactList import status.
getOutboundContactlistImportstatus 1 param → 200400401403404408409413
GET
/api/v2/outbound/contactlists/{contactListId}
Get a dialer contact list.
getOutboundContactlist 3 params → 200400401403404408409413
PUT
/api/v2/outbound/contactlists/{contactListId}
Update a contact list.
putOutboundContactlist 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/contactlists/{contactListId}
Delete a contact list.
deleteOutboundContactlist 1 param → 200400401403404408409413
GET
/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview
Preview the result of applying Automatic Time Zone Mapping to a contact list
getOutboundContactlistTimezonemappingpreview 1 param → 200400401403404408409413
GET
/api/v2/outbound/contactlisttemplates/{contactListTemplateId}
Get Contact List Template
getOutboundContactlisttemplate 1 param → 200400401403404408409413
PUT
/api/v2/outbound/contactlisttemplates/{contactListTemplateId}
Update a contact list template.
putOutboundContactlisttemplate 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/contactlisttemplates/{contactListTemplateId}
Delete Contact List Template
deleteOutboundContactlisttemplate 1 param → 204400401403404408409413
GET
/api/v2/outbound/contactlisttemplates
Query a list of contact list templates
getOutboundContactlisttemplates 7 params → 200400401403404408409413
POST
/api/v2/outbound/contactlisttemplates
Create Contact List Template
postOutboundContactlisttemplates 1 param → 200400401403404408409413
DELETE
/api/v2/outbound/contactlisttemplates
Delete multiple contact list templates.
deleteOutboundContactlisttemplates 1 param → 204400401403404408409413
POST
/api/v2/outbound/contactlisttemplates/bulk/add
Add multiple contact list templates
postOutboundContactlisttemplatesBulkAdd 1 param → 200400401403404408409413
POST
/api/v2/outbound/contactlisttemplates/bulk/retrieve
Get multiple contact list templates
postOutboundContactlisttemplatesBulkRetrieve 1 param → 200400401403404408409413
GET
/api/v2/outbound/contactlists
Query a list of contact lists.
getOutboundContactlists 11 params → 200400401403404408409413
POST
/api/v2/outbound/contactlists
Create a contact List.
postOutboundContactlists 1 param → 200400401403404408409413
DELETE
/api/v2/outbound/contactlists
Delete multiple contact lists.
deleteOutboundContactlists 1 param → 204400401403404408409413
POST
/api/v2/outbound/contactlists/uploads
Generate presigned upload URL for contact list.
postOutboundContactlistsUploads 1 param → 200400401403404408409413
GET
/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
Get a contact.
getOutboundContactlistContact 2 params → 200400401403404408409413
PUT
/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
Update a contact.
putOutboundContactlistContact 3 params → 200400401403404408409413
DELETE
/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
Delete a contact.
deleteOutboundContactlistContact 2 params → 200400401403404408409413
POST
/api/v2/outbound/contactlists/{contactListId}/clear
Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
postOutboundContactlistClear 1 param → 204400401403404408409413
GET
/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId}
Get bulk operation job.
getOutboundContactlistContactsBulkJob 2 params → 200400401403404408409413
GET
/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs
Get 10 most recent bulk operation jobs associated with contact list.
getOutboundContactlistContactsBulkJobs 1 param → 200400401403404408409413
POST
/api/v2/outbound/contactlists/{contactListId}/contacts/bulk
Get contacts from a contact list.
postOutboundContactlistContactsBulk 2 params → 200400401403404408409413
POST
/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove
Start an async job to delete contacts using a filter.
postOutboundContactlistContactsBulkRemove 2 params → 200202400401403404408409
POST
/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update
Start an async job to bulk edit contacts.
postOutboundContactlistContactsBulkUpdate 2 params → 200202400401403404408409
POST
/api/v2/outbound/contactlists/{contactListId}/contacts/search
Query contacts from a contact list.
postOutboundContactlistContactsSearch 2 params → 200400401403404408409413
POST
/api/v2/outbound/contactlists/{contactListId}/contacts
Add contacts to a contact list.
postOutboundContactlistContacts 5 params → 200400401403404408409413
DELETE
/api/v2/outbound/contactlists/{contactListId}/contacts
Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
deleteOutboundContactlistContacts 2 params → 200400401403404408409413
POST
/api/v2/outbound/dnclists/uploads
Generate presigned upload URL for dnc list.
postOutboundDnclistsUploads 1 param → 200400401403404408409413
POST
/api/v2/outbound/conversations/{conversationId}/dnc
Add phone numbers to a Dialer DNC list.
postOutboundConversationDnc 1 param → default400401403404408409413
DELETE
/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns
Deletes all or expired custom exclusion column entries from a DNC list.
deleteOutboundDnclistCustomexclusioncolumns 2 params → 204400401403404408409413
PATCH
/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns
Add entries to or delete entries from a DNC list.
patchOutboundDnclistCustomexclusioncolumns 2 params → 204400401403404408409413
GET
/api/v2/outbound/dnclists/divisionviews/{dncListId}
Get a basic DncList information object
getOutboundDnclistsDivisionview 3 params → 200400401403404408409413
GET
/api/v2/outbound/dnclists/divisionviews
Query a list of simplified dnc list objects.
getOutboundDnclistsDivisionviews 10 params → 200400401403404408409413
POST
/api/v2/outbound/dnclists/{dncListId}/emailaddresses
Add email addresses to a DNC list.
postOutboundDnclistEmailaddresses 2 params → 204400401403404408409413
DELETE
/api/v2/outbound/dnclists/{dncListId}/emailaddresses
Deletes all or expired email addresses from a DNC list.
deleteOutboundDnclistEmailaddresses 2 params → 204400401403404408409413
PATCH
/api/v2/outbound/dnclists/{dncListId}/emailaddresses
Add emails to or Delete emails from a DNC list.
patchOutboundDnclistEmailaddresses 2 params → 204400401403404408409413
GET
/api/v2/outbound/dnclists/{dncListId}/export
Get the URI of a DNC list export.
getOutboundDnclistExport 2 params → 200400401403404408409413
POST
/api/v2/outbound/dnclists/{dncListId}/export
Initiate the export of a dnc list.
postOutboundDnclistExport 1 param → 200400401403404408409413
GET
/api/v2/outbound/dnclists/{dncListId}/importstatus
Get dialer dncList import status.
getOutboundDnclistImportstatus 1 param → 200400401403404408409413
POST
/api/v2/outbound/dnclists/{dncListId}/phonenumbers
Add phone numbers to a DNC list.
postOutboundDnclistPhonenumbers 3 params → default400401403404408409413
DELETE
/api/v2/outbound/dnclists/{dncListId}/phonenumbers
Deletes all or expired phone numbers from a DNC list.
deleteOutboundDnclistPhonenumbers 2 params → 204400401403404408409413
PATCH
/api/v2/outbound/dnclists/{dncListId}/phonenumbers
Add numbers to or delete numbers from a DNC list.
patchOutboundDnclistPhonenumbers 2 params → 204400401403404408409413
GET
/api/v2/outbound/dnclists/{dncListId}
Get dialer DNC list
getOutboundDnclist 3 params → 200400401403404408409413
PUT
/api/v2/outbound/dnclists/{dncListId}
Update dialer DNC list
putOutboundDnclist 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/dnclists/{dncListId}
Delete dialer DNC list
deleteOutboundDnclist 1 param → 200400401403404408409413
DELETE
/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers
Deletes all or expired whatsApp numbers from a DNC list.
deleteOutboundDnclistWhatsappnumbers 2 params → 204400401403404408409413
PATCH
/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers
Add entries to or delete entries from a DNC list.
patchOutboundDnclistWhatsappnumbers 2 params → 204400401403404408409413
GET
/api/v2/outbound/dnclists
Query dialer DNC lists
getOutboundDnclists 11 params → 200400401403404408409413
POST
/api/v2/outbound/dnclists
Create dialer DNC list
postOutboundDnclists 1 param → 200400401403404408409413
GET
/api/v2/outbound/events/{eventId}
Get Dialer Event
getOutboundEvent 1 param → 200400401403404408409413
GET
/api/v2/outbound/events
Query Event Logs
getOutboundEvents 7 params → 200400401403404408409413
DELETE
/api/v2/outbound/filespecificationtemplates/bulk
Delete multiple file specification templates.
deleteOutboundFilespecificationtemplatesBulk 1 param → 204400401403404408409413
GET
/api/v2/outbound/filespecificationtemplates
Query File Specification Templates
getOutboundFilespecificationtemplates 7 params → 200400401403404408409413
POST
/api/v2/outbound/filespecificationtemplates
Create File Specification Template
postOutboundFilespecificationtemplates 1 param → 200400401403404408409413
GET
/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}
Get File Specification Template
getOutboundFilespecificationtemplate 1 param → 200400401403404408409413
PUT
/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}
Update File Specification Template
putOutboundFilespecificationtemplate 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}
Delete File Specification Template
deleteOutboundFilespecificationtemplate 1 param → 204400401403404408409413
GET
/api/v2/outbound/importtemplates/{importTemplateId}/importstatus
Get the import status for an import template.
getOutboundImporttemplateImportstatus 2 params → 200400401403404408409413
GET
/api/v2/outbound/importtemplates/{importTemplateId}
Get Import Template
getOutboundImporttemplate 2 params → 200400401403404408409413
PUT
/api/v2/outbound/importtemplates/{importTemplateId}
Update Import Template
putOutboundImporttemplate 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/importtemplates/{importTemplateId}
Delete Import Template
deleteOutboundImporttemplate 1 param → 204400401403404408409413
GET
/api/v2/outbound/importtemplates
Query Import Templates
getOutboundImporttemplates 9 params → 200400401403404408409413
POST
/api/v2/outbound/importtemplates
Create Import Template
postOutboundImporttemplates 1 param → 200400401403404408409413
DELETE
/api/v2/outbound/importtemplates
Delete multiple import templates.
deleteOutboundImporttemplates 1 param → 204400401403404408409413
POST
/api/v2/outbound/importtemplates/bulk/add
Add multiple import templates
postOutboundImporttemplatesBulkAdd 1 param → 200400401403404408409413
POST
/api/v2/outbound/messagingcampaigns/progress
Get progress for a list of messaging campaigns
postOutboundMessagingcampaignsProgress 1 param → 200400401403404408409413
GET
/api/v2/outbound/settings
Get the outbound settings for this organization
getOutboundSettings → 200400401403404408409413
PATCH
/api/v2/outbound/settings
Update the outbound settings for this organization
patchOutboundSettings 2 params → 204400401403404408409413
GET
/api/v2/outbound/rulesets/{ruleSetId}
Get a Rule Set by ID.
getOutboundRuleset 1 param → 200400401403404408409413
PUT
/api/v2/outbound/rulesets/{ruleSetId}
Update a Rule Set.
putOutboundRuleset 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/rulesets/{ruleSetId}
Delete a Rule Set.
deleteOutboundRuleset 1 param → 200400401403404408409413
GET
/api/v2/outbound/rulesets
Query a list of Rule Sets.
getOutboundRulesets 7 params → 200400401403404408409413
POST
/api/v2/outbound/rulesets
Create a Rule Set.
postOutboundRulesets 1 param → 200400401403404408409413
GET
/api/v2/outbound/sequences/{sequenceId}
Get a dialer campaign sequence.
getOutboundSequence 1 param → 200400401403404408409413
PUT
/api/v2/outbound/sequences/{sequenceId}
Update a new campaign sequence.
putOutboundSequence 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/sequences/{sequenceId}
Delete a dialer campaign sequence.
deleteOutboundSequence 1 param → 200400401403404408409413
GET
/api/v2/outbound/schedules/sequences/{sequenceId}
Get a dialer sequence schedule.
getOutboundSchedulesSequence 1 param → 200400401403404408409413
PUT
/api/v2/outbound/schedules/sequences/{sequenceId}
Update a new sequence schedule.
putOutboundSchedulesSequence 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/schedules/sequences/{sequenceId}
Delete a dialer sequence schedule.
deleteOutboundSchedulesSequence 1 param → 200400401403404408409413
GET
/api/v2/outbound/schedules/sequences
Query for a list of dialer sequence schedules.
getOutboundSchedulesSequences → 200400401403404408409413
GET
/api/v2/outbound/sequences
Query a list of dialer campaign sequences.
getOutboundSequences 7 params → 200400401403404408409413
POST
/api/v2/outbound/sequences
Create a new campaign sequence.
postOutboundSequences 1 param → 200400401403404408409413
GET
/api/v2/outbound/wrapupcodemappings
Get the Dialer wrap up code mapping.
getOutboundWrapupcodemappings → 200400401403404408409413
PUT
/api/v2/outbound/wrapupcodemappings
Update the Dialer wrap up code mapping.
putOutboundWrapupcodemappings 1 param → 200400401403404408409413
GET
/api/v2/outbound/diagnostics/campaigns/{campaignId}/summary
Get diagnostic summary for a single campaign
getOutboundDiagnosticsCampaignSummary 3 params → 200400401403404408409413
GET
/api/v2/outbound/digitalrulesets/{digitalRuleSetId}
Get an Outbound Digital Rule Set
getOutboundDigitalruleset 1 param → 200400401403404408409413
PUT
/api/v2/outbound/digitalrulesets/{digitalRuleSetId}
Update an Outbound Digital Rule Set
putOutboundDigitalruleset 2 params → 200409400401403404408413
DELETE
/api/v2/outbound/digitalrulesets/{digitalRuleSetId}
Delete an Outbound Digital Rule Set
deleteOutboundDigitalruleset 1 param → 204400401403404408409413
GET
/api/v2/outbound/digitalrulesets
Query a list of Outbound Digital Rule Sets
getOutboundDigitalrulesets 6 params → 200400401403404408409413
POST
/api/v2/outbound/digitalrulesets
Create an Outbound Digital Rule Set
postOutboundDigitalrulesets 1 param → 200400401403404408409413
GET
/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}
Get a basic Messaging Campaign information object
getOutboundMessagingcampaignsDivisionview 1 param → 200400401403404408409413
GET
/api/v2/outbound/messagingcampaigns/divisionviews
Query a list of basic Messaging Campaign information objects
getOutboundMessagingcampaignsDivisionviews 9 params → 200400401403404408409413
GET
/api/v2/outbound/messagingcampaigns/{messagingCampaignId}
Get an Outbound Messaging Campaign
getOutboundMessagingcampaign 1 param → 200400401403404408409413
PUT
/api/v2/outbound/messagingcampaigns/{messagingCampaignId}
Update an Outbound Messaging Campaign
putOutboundMessagingcampaign 2 params → 200409400401403404408413
DELETE
/api/v2/outbound/messagingcampaigns/{messagingCampaignId}
Delete an Outbound Messaging Campaign
deleteOutboundMessagingcampaign 1 param → 200204400401403404408409
GET
/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress
Get messaging campaign's progress
getOutboundMessagingcampaignProgress 1 param → 200400401403404408409413
DELETE
/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress
Reset messaging campaign progress and recycle the messaging campaign
deleteOutboundMessagingcampaignProgress 1 param → 204400401403404408409413
GET
/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics
Get messaging campaign diagnostics
getOutboundMessagingcampaignDiagnostics 1 param → 200400401403404408409413
POST
/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start
Start the campaign
postOutboundMessagingcampaignStart 1 param → 204400401403404408409413
POST
/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop
Stop the campaign
postOutboundMessagingcampaignStop 1 param → 204400401403404408409413
GET
/api/v2/outbound/messagingcampaigns
Query a list of Messaging Campaigns
getOutboundMessagingcampaigns 13 params → 200400401403404408409413
POST
/api/v2/outbound/messagingcampaigns
Create a Messaging Campaign
postOutboundMessagingcampaigns 1 param → 200400401403404408409413
GET
/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}
Get an email campaign schedule.
getOutboundSchedulesEmailcampaign 1 param → 200400401403404408409413
PUT
/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}
Update an email campaign schedule.
putOutboundSchedulesEmailcampaign 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}
Delete an email campaign schedule.
deleteOutboundSchedulesEmailcampaign 1 param → 204400401403404408409413
GET
/api/v2/outbound/schedules/emailcampaigns
Query for a list of email campaign schedules.
getOutboundSchedulesEmailcampaigns → 200400401403404408409413
GET
/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}
Get a messaging campaign schedule.
getOutboundSchedulesMessagingcampaign 1 param → 200400401403404408409413
PUT
/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}
Update a new messaging campaign schedule.
putOutboundSchedulesMessagingcampaign 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}
Delete a messaging campaign schedule.
deleteOutboundSchedulesMessagingcampaign 1 param → 204400401403404408409413
GET
/api/v2/outbound/schedules/messagingcampaigns
Query for a list of messaging campaign schedules.
getOutboundSchedulesMessagingcampaigns → 200400401403404408409413
GET
/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}
Get a WhatsApp campaign schedule.
getOutboundSchedulesWhatsappcampaign 1 param → 200400401403404408409413
PUT
/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}
Update a WhatsApp campaign schedule.
putOutboundSchedulesWhatsappcampaign 2 params → 200400401403404408409413
DELETE
/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}
Delete a WhatsApp campaign schedule.
deleteOutboundSchedulesWhatsappcampaign 1 param → 204400401403404408409413
GET
/api/v2/outbound/schedules/whatsappcampaigns
Query for a list of WhatsApp campaign schedules.
getOutboundSchedulesWhatsappcampaigns → 200400401403404408409413

Schemas 368

The contract defines 368 schemas that model the data the API accepts and returns. The most detailed are ParticipantBasic (50 properties), Evaluation (43 properties), Campaign (42 properties), Queue (41 properties). Each schema is shown below with its type and property counts.

ContactAddressConditionSettings
object
2 properties 2 required
ContactableStatus
object
2 properties
WritableDivision
object
3 properties
FaxStatus
object
8 properties
CampaignRuleActionEntities
object
5 properties
AdjustableLiveSpeakerDetection
object
6 properties
MessagingCampaignScheduleEntityListing
object
10 properties
Script
object
15 properties
Disposition
object
7 properties 1 required
MediaSummary
object
2 properties
CampaignRuleEntities
object
4 properties
ContactListTemplateBulkRetrieveBody
object
1 property 1 required
MarkContactAddressUncontactableActionSettings
object
DigitalRuleSetEntityListing
object
10 properties
ContactListTemplateEntityListing
object
10 properties
CampaignSequence
object
11 properties 3 required
CallableWindow
object
2 properties
AiScoringSettings
object
3 properties
ContactsExportRequest
object
3 properties
SkillCombinationInfo
object
3 properties
EvaluationReference
object
2 properties
ContactListingRequest
object
5 properties 2 required
ContactColumnToDataActionFieldMapping
object
2 properties 2 required
AppendToDncActionSettings
object
3 properties 1 required
ContactListFilterClause
object
2 properties
RuleSetDiagnostic
object
2 properties
ReplyToEmailAddress
object
2 properties 2 required
UploadUrlResponse
object
3 properties
MediaSummaryDetail
object
2 properties
EmailConfig
object
4 properties 2 required
CampaignRuleWeekDayOfMonthInterval
object
2 properties 2 required
DncPatchWhatsAppNumbersRequest
object
3 properties
CampaignPerformanceDataContactRate
object
1 property
Email
object
27 properties
DNCListUploadUrlRequest
object
8 properties 2 required
DncListCreate
object
16 properties 2 required
CommonCampaignEntityListing
object
10 properties
DncListDivisionViewListing
object
10 properties
EvaluationQuestionGroupScore
object
16 properties
JourneyAction
object
2 properties 2 required
CampaignDiagnosticCampaignState
object
4 properties
ContactBulkEditRequest
object
5 properties
DispositionParameters
object
1 property
MessageSubtypeSettings
object
2 properties
CampaignRuleWeekDayOfMonthParameters
object
2 properties
EvaluationSettingsAssignee
object
2 properties
Calibration
object
16 properties
JourneyCustomer
object
2 properties 2 required
ImportTemplateEntityListing
object
10 properties
ServiceLevel
object
2 properties
ContactListEntityListing
object
10 properties
RecordersState
object
4 properties
DefaultAnswersTo
object
4 properties
CampaignTimeSlot
object
3 properties 3 required
OutOfOffice
object
8 properties
ScoredAgent
object
2 properties
CampaignProgress
object
7 properties 2 required
CampaignSequenceEntityListing
object
10 properties
AiScoringSetting
object
1 property
MessageDetails
object
10 properties
SplittingInformation
object
4 properties
ConversationChat
object
22 properties
CampaignRuleAction
object
4 properties 2 required
RoutingStatus
object
3 properties
CallableContactsDiagnostic
object
4 properties
ResourceConditionValue
object
2 properties
MessagingCampaign
object
21 properties 2 required
MessagingCampaignDiagnostics
object
2 properties
DigitalCondition
object
9 properties
LastResultOverallConditionSettings
object
3 properties
DialerPreview
object
6 properties
InternalMessage
object
15 properties
EvaluationQuestionGroup
object
12 properties
CampaignOutboundLinesDistribution
object
Lines distribution information or Campaign's Edge Group or Site
7 properties
AgentOwnedRouting
object
3 properties
UserConversationSummary
object
8 properties
Education
object
5 properties
DncList
object
16 properties 2 required
MessageMedia
object
5 properties
UserReferenceWithName
object
3 properties
CommonCampaign
object
5 properties
MessagingCampaignDivisionView
object
4 properties
ErrorBody
object
11 properties
CampaignEntityListing
object
10 properties
LocationImage
object
2 properties
ConditionalGroupActivationSimpleMetric
object
2 properties
WritableDialerContact
object
10 properties 2 required
DigitalDataActionConditionPredicate
object
5 properties 5 required
CampaignRuleCampaignRunTimeSettings
object
1 property
EvaluationSettings
object
4 properties
ConditionalGroupRouting
object
1 property
MediaSettings
object
5 properties
DynamicLineBalancingSettingsPatchRequest
object
2 properties
JourneyActionMap
object
2 properties 2 required
UserStation
object
8 properties
ConditionalGroupActivationRule
object
3 properties
MessageMediaSettings
object
8 properties
AttemptLimits
object
11 properties
MessageSticker
object
2 properties
CampaignDiagnostics
object
14 properties
CampaignRuleCondition
object
6 properties 2 required
AgentOwnedMappingPreviewListing
object
1 property
DomainEntityListingEvaluationForm
object
10 properties
CampaignPerformanceData
object
14 properties 1 required
CampaignDiagnosticSummary
object
7 properties
UpdateContactColumnActionSettings
object
2 properties 2 required
ResourcePermissionPolicy
object
11 properties
DiagnosticsSettings
object
1 property
Agent
object
1 property
AiScoring
object
3 properties
CampaignLinesUtilization
object
2 properties
CampaignDivisionView
object
4 properties
SetWhatsAppIntegrationActionSettings
object
1 property 1 required
FileSpecificationTemplate
object
15 properties 2 required
QuestionSettings
object
2 properties
LastAttemptOverallConditionSettings
object
3 properties 3 required
ConditionalGroupActivationPilotRule
object
2 properties
CampaignRuleDayOfMonthInterval
object
2 properties
AcwSettings
object
2 properties
MessagingCampaignEntityListing
object
10 properties
ContactListDivisionView
object
10 properties 1 required
DirectRoutingMediaSettings
object
1 property
CampaignRuleEntityListing
object
10 properties
LastResultByColumnConditionSettings
object
6 properties
ImportStatus
object
7 properties 4 required
Geolocation
object
11 properties
ContactBulkSearchParameters
object
3 properties
RestErrorDetail
object
3 properties 1 required
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
ConditionalGroupActivationCondition
object
3 properties
CampaignRuleDateTimeConditionParameters
object
6 properties
TopicDuration
object
1 property
CampaignRuleParameters
object
15 properties
MessageEvaluation
object
5 properties
Biography
object
5 properties
SmsConfig
object
4 properties 3 required
CampaignPerformanceDataListing
object
1 property
RuleSet
object
9 properties 2 required
ConversationDivisionMembership
object
2 properties
EmailAddress
object
2 properties
EvaluationQuestionScore
object
10 properties
EvaluationVersion
object
3 properties
ConnectRate
object
3 properties
InactivityTimeoutSettings
object
3 properties
ContactListFilterPredicate
object
6 properties
DomainRole
object
2 properties
PresenceDefinition
object
3 properties
ConversationRoutingData
object
8 properties
CampaignRuleDayOfMonthParameters
object
3 properties
Duration
object
5 properties
Range
object
3 properties 1 required
TimeZoneMappingPreview
object
9 properties
ContactListTemplate
object
17 properties 1 required
CampaignRuleWarningParameters
object
4 properties
CallableTime
object
3 properties 2 required
Attachment
object
6 properties
DataActionConditionPredicate
object
5 properties 5 required
CampaignRuleSpecificDateInterval
object
2 properties
PhoneNumberColumn
object
3 properties
DoNotSendActionSettings
object
Voicemail
object
2 properties
CallbackMediaSettings
object
18 properties
OutboundSettings
object
14 properties
WhatsAppColumn
object
4 properties 2 required
FileSpecificationTemplateEntityListing
object
10 properties
ConfigurationOverrides
object
1 property
GroupContact
object
5 properties 3 required
LocationDefinition
object
16 properties
Image
object
2 properties
QueueUtilizationDiagnostic
object
9 properties
AutomaticTimeZoneMappingSettings
object
2 properties
EvaluationForm
object
12 properties 2 required
WhatsAppCampaignScheduleEntityListing
object
10 properties
DivisionEntityRef
object
4 properties
DigitalRuleSet
object
8 properties 1 required
DataActionContactColumnFieldMapping
object
2 properties 2 required
ColumnDataTypeSpecification
object
5 properties
AssistanceCondition
object
2 properties
DisconnectReason
object
4 properties
Bullseye
object
1 property
FromEmailAddress
object
3 properties 1 required
CampaignDiagnosticCampaignHealthState
object
3 properties
PhoneNumberStatus
object
1 property
ContactListFilterBulkRetrieveBody
object
1 property 1 required
DialerEventEntityListing
object
10 properties
ContactListFilterEntityListing
object
10 properties
SetContentTemplateActionSettings
object
3 properties 3 required
ColumnStatus
object
1 property
ContactAddressTypeConditionSettings
object
2 properties 2 required
Message
object
33 properties
ContactListFilter
object
11 properties 1 required
LastAttemptByColumnConditionSettings
object
5 properties 2 required
CannedResponseLibraries
object
2 properties
ContactsBulkOperationJob
object
9 properties
DialerAction
object
9 properties 2 required
LocationAddress
object
7 properties
CampaignStats
object
12 properties
Team
object
8 properties 1 required
WorkPlanBidRanks
object
4 properties
AddressableEntityRef
object
2 properties
CampaignInteractions
object
6 properties
ScreenMonitoring
object
12 properties
CampaignRuleSpecificDateParameters
object
3 properties
CampaignOutboundLinesReservation
object
2 properties
ContactSort
object
3 properties
DigitalRule
object
6 properties 5 required
Wrapup
object
7 properties
PagedSkillCombinationListing
object
5 properties
LocationAddressVerificationDetails
object
4 properties
Screenshare
object
16 properties
ExpansionCriterium
object
2 properties
ContactListDivisionViewListing
object
10 properties
CallRecord
object
2 properties
Reoccurrence
object
8 properties 4 required
ScheduleInterval
object
2 properties 2 required
ContactsBulkOperationJobListing
object
3 properties
EmailCampaignScheduleEntityListing
object
10 properties
Page
object
8 properties
MarkContactUncontactableActionSettings
object
1 property 1 required
Reaction
object
3 properties 1 required
CampaignSkillStatistics
object
2 properties
AnswerOption
object
6 properties
ConditionalGroupActivation
object
2 properties
ContactColumnTimeZone
object
2 properties
DomainEntityRef
object
3 properties
Column
object
4 properties
DynamicLineBalancingSettings
object
2 properties
OccurrenceDetails
object
2 properties
CampaignRuleTimeOfDayParameters
object
2 properties
Campaign
object
42 properties 6 required
CampaignPatchRequest
object
Campaign patch request
5 properties
DncPatchPhoneNumbersRequest
object
3 properties
SetSmsPhoneNumberActionSettings
object
1 property 1 required
CallableTimeSetEntityListing
object
10 properties
Detail
object
4 properties
CampaignBusinessCategoryMetrics
object
3 properties
CampaignDiagnosticWindow
object
3 properties
MessagingCampaignSchedule
object
10 properties 2 required
CampaignRuleWeekDayOfMonth
object
3 properties 1 required
EvaluationScoringSet
object
11 properties
UserAuthorization
object
4 properties
Address
object
5 properties
CallBasic
object
35 properties
EmailCampaignSchedule
object
10 properties 2 required
UserPresence
object
10 properties
DirectRouting
object
6 properties
PhoneColumn
object
2 properties 2 required
Cobrowsesession
object
19 properties
DivisionedDomainEntityRef
object
4 properties
DigitalAction
object
8 properties
CampaignInteraction
object
21 properties
SkillsToRemove
object
3 properties
ContactCallbackRequest
object
5 properties 5 required
CallableTimeSet
object
7 properties 2 required
DialerContact
object
15 properties 2 required
Limit
object
3 properties
ConversationMessageMetadata
object
Metadata information about a message.
3 properties
CampaignPerformanceDataProgress
object
1 property
CampaignRule
object
16 properties 4 required
Contact
object
7 properties
AfterCallWork
object
3 properties
ConditionalGroupRoutingRule
object
6 properties
Division
object
3 properties
ConversationReference
object
2 properties
ConversationMessageMetadataEvent
object
Metadata information about a message event.
2 properties
SocialExpression
object
20 properties
JourneyCustomerSession
object
2 properties 2 required
DefaultAnswer
object
2 properties
CommonCampaignDivisionViewEntityListing
object
10 properties
CampaignRuleWarning
object
3 properties 2 required
EvaluationSource
object
4 properties
QueueMediaSettings
object
5 properties
DivisionReference
object
2 properties
CampaignOutboundLinesAllocation
object
4 properties
ErrorInfo
object
2 properties
Video
object
19 properties
ContactListingResponse
object
11 properties
TimeAndDateSubCondition
object
6 properties
TimeAndDateSubConditionRange
object
3 properties
RuleSetEntityListing
object
10 properties
ContactList
object
20 properties 1 required
ExportUri
object
2 properties
AtzmTimeSlotWithTimeZone
object
3 properties
UserStations
object
4 properties
OAuthLastTokenIssued
object
1 property
ConversationMessageMetadataContent
object
Metadata information about a message content.
2 properties
ConversationBasic
object
11 properties 1 required
Queue
object
41 properties
CampaignRuleDayOfWeekParameters
object
2 properties
CampaignRuleCampaignWaitTimeSettings
object
1 property 1 required
PreprocessingRule
object
4 properties
DispositionSilentCallTimeout
object
3 properties
CallbackBasic
object
29 properties
EventLog
object
10 properties
PagelessDomainEntityListingEvaluationVersion
object
3 properties
WhatsAppCampaignSchedule
object
10 properties 2 required
NextOccurrenceDetails
object
2 properties
User
object
39 properties 1 required
InternalMessageDetails
object
2 properties
TemporalUnit
object
4 properties
CampaignDivisionViewListing
object
10 properties
FilterPreviewResponse
object
3 properties
EmailMediaSettings
object
5 properties
EventMessage
object
6 properties
WrapUpCodeMapping
object
8 properties
SequenceSchedule
object
10 properties 2 required
DialerRule
object
6 properties 3 required
EmailColumn
object
4 properties 2 required
ResourceConditionNode
object
5 properties
ContactListFilterRange
object
5 properties
CampaignSchedule
object
10 properties 2 required
EvaluationQuestion
object
14 properties
Condition
object
19 properties
Empty
object
CommonCampaignDivisionView
object
5 properties
AgentOwnedMappingPreview
object
6 properties
CampaignRuleDayOfWeekInterval
object
2 properties
AiAnswer
object
3 properties
QueueMessagingAddresses
object
3 properties
DncPatchCustomExclusionColumnsRequest
object
3 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
Signature
object
4 properties
MemberGroup
object
6 properties
Alteration
object
3 properties
Pattern
object
3 properties 2 required
CampaignRuleConditionGroup
object
2 properties 2 required
AttemptLimitsEntityListing
object
10 properties
QuestionGroupSettings
object
2 properties
MessagingCampaignDivisionViewEntityListing
object
10 properties
LocationEmergencyNumber
object
3 properties
EmployerInfo
object
4 properties
CampaignRuleTimeOfDayInterval
object
2 properties
RoutingRule
object
3 properties
ContactListUploadUrlRequest
object
9 properties 1 required
InboundRoute
object
19 properties 2 required
AtzmTimeSlot
object
2 properties
DncListDivisionView
object
8 properties
ContactBulkSearchCriteria
object
2 properties
CampaignRuleExecutionSettings
object
2 properties 1 required
DncPatchEmailsRequest
object
3 properties
ResponseSetEntityListing
object
10 properties
ContactPhoneNumberColumn
object
4 properties 2 required
UserParam
object
2 properties
Chat
object
1 property
RecallEntry
object
2 properties
ImportTemplate
object
13 properties 1 required
CampaignDiagnosticConfigChange
object
4 properties
WhatsAppConfig
object
3 properties 3 required
JourneyContext
object
3 properties 1 required
QueueEmailAddress
object
2 properties
DncListEntityListing
object
10 properties
Actions
object
1 property
TranscriptTopic
object
9 properties
ConversationQueueMediaSettings
object
4 properties
DispositionAmdTimeout
object
4 properties
SmsPhoneNumberRef
object
2 properties 1 required
VisibilityCondition
object
2 properties
DataActionConditionSettings
object
5 properties 2 required
TopicOffset
object
2 properties
ResponseSet
object
10 properties 2 required
ContactColumnConditionSettings
object
4 properties 4 required
DynamicContactQueueingSettings
object
2 properties
Evaluation
object
43 properties
Group
object
17 properties 4 required
Location
object
5 properties
ParticipantBasic
object
50 properties
Segment
object
5 properties 2 required
Ring
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-outbound-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

This is an independent, third-party profile of Genesys Outbound API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.