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 Social Media API

Resources and analytics related to social media listening and response

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

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

This API exposes 49 operations across 31 paths, and defines 130 schemas. It is described by OpenAPI 2.0, at version v2.

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

49 operations 31 paths 130 schemas 6 DELETE21 GET5 PATCH12 POST5 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 Social Media 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 49

Across 31 paths, the API surfaces 49 operations — 6 DELETE, 21 GET, 5 PATCH, 12 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Social Media 49

Resources and analytics related to social media listening and response

POST
/api/v2/socialmedia/analytics/aggregates/jobs
Query for social media aggregates asynchronously
postSocialmediaAnalyticsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}
Get status for async query for social media aggregates
getSocialmediaAnalyticsAggregatesJob 1 param → 200400401403404408409413
GET
/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results
Fetch a page of results for an async social media query
getSocialmediaAnalyticsAggregatesJobResults 2 params → 200400401403404408409413
GET
/api/v2/socialmedia/analytics/messages/jobs/{jobId}
Get status for async query for social media messages job
getSocialmediaAnalyticsMessagesJob 1 param → 200400401403404408409413
GET
/api/v2/socialmedia/analytics/messages/jobs/{jobId}/results
Fetch a page of results for an async social media messages query
getSocialmediaAnalyticsMessagesJobResults 2 params → 200400401403404408409413
POST
/api/v2/socialmedia/analytics/messages/jobs
Query for social media messages asynchronously
postSocialmediaAnalyticsMessagesJobs 1 param → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules
Retrieve all social topic data ingestion rules with pagination.
getSocialmediaTopicDataingestionrules 4 params → 200400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}
Get a single Facebook data ingestion rule.
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId 3 params → 200400401403404408409413
PUT
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}
Update the Facebook data ingestion rule.
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId 3 params → 202400401403404408409413
DELETE
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}
Delete a Facebook data ingestion rule.
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId 3 params → 204400401403404408409413
PATCH
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}
Update the status of a Facebook data ingestion rule.
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId 3 params → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}
Get a single Facebook data ingestion rule version.
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion 4 params → 200400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions
Get the Facebook data ingestion rule versions.
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions 5 params → 200400401403404408409413
POST
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook
Create an Facebook data ingestion rule.
postSocialmediaTopicDataingestionrulesFacebook 2 params → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}
Get a single Instagram data ingestion rule.
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId 3 params → 200400401403404408409413
PUT
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}
Update the Instagram data ingestion rule.
putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId 3 params → 202400401403404408409413
DELETE
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}
Delete a Instagram data ingestion rule.
deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId 3 params → 204400401403404408409413
PATCH
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}
Update the status of a Instagram data ingestion rule.
patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId 3 params → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions/{dataIngestionRuleVersion}
Get a single Instagram data ingestion rule version.
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion 4 params → 200400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions
Get the Instagram data ingestion rule versions.
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions 5 params → 200400401403404408409413
POST
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram
Create an Instagram data ingestion rule.
postSocialmediaTopicDataingestionrulesInstagram 2 params → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}
Get a single open data ingestion rule.
getSocialmediaTopicDataingestionrulesOpenOpenId 3 params → 200400401403404408409413
PUT
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}
Update the open data ingestion rule.
putSocialmediaTopicDataingestionrulesOpenOpenId 3 params → 202400401403404408409413
DELETE
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}
Delete a open data ingestion rule.
deleteSocialmediaTopicDataingestionrulesOpenOpenId 3 params → 204400401403404408409413
PATCH
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}
Update the status of a open data ingestion rule.
patchSocialmediaTopicDataingestionrulesOpenOpenId 3 params → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}
Get a single Open data ingestion rule version.
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion 4 params → 200400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions
Get the Open data ingestion rule versions.
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions 5 params → 200400401403404408409413
POST
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open
Create an open data ingestion rule.
postSocialmediaTopicDataingestionrulesOpen 2 params → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}
Get a single X (formally Twitter) data ingestion rule.
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId 3 params → 200400401403404408409413
PUT
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}
Update the X (formally Twitter) data ingestion rule.
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId 3 params → 202400401403404408409413
DELETE
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}
Delete a X (formally Twitter) data ingestion rule.
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId 3 params → 204400401403404408409413
PATCH
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}
Update the status of a X (formally Twitter) data ingestion rule.
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId 3 params → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}
Get a single X (formally Twitter) data ingestion rule version.
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion 4 params → 200400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions
Get the Open data ingestion rule versions.
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions 5 params → 200400401403404408409413
POST
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter
Create an twitter data ingestion rule.
postSocialmediaTopicDataingestionrulesTwitter 2 params → 202400401403404408409413
POST
/api/v2/socialmedia/twitter/historical/tweets
Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
postSocialmediaTwitterHistoricalTweets 1 param → 200400401403404408409413
GET
/api/v2/socialmedia/escalationrules/{escalationRuleId}
Get a single escalation rule.
getSocialmediaEscalationrule 2 params → 200400401403404408409413
PUT
/api/v2/socialmedia/escalationrules/{escalationRuleId}
Update the escalation rule.
putSocialmediaEscalationrule 2 params → 202400401403404408409413
DELETE
/api/v2/socialmedia/escalationrules/{escalationRuleId}
Delete an escalation rule.
deleteSocialmediaEscalationrule 1 param → 204400401403404408409413
GET
/api/v2/socialmedia/escalationrules
Retrieve all escalation rules for a division.
getSocialmediaEscalationrules 3 params → 200400401403404408409413
POST
/api/v2/socialmedia/escalationrules
Create an escalation rule.
postSocialmediaEscalationrules 1 param → 200400401403404408409413
POST
/api/v2/socialmedia/escalations/messages
Escalate message to a conversation manually
postSocialmediaEscalationsMessages 2 params → 200400401403404408409413
POST
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/reactions/bulk
Ingest a list of Open Social Reactions
postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk 3 params → 202400401403404408409413
POST
/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/messages/bulk
Ingest a list of Open Social Messages
postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk 3 params → 202400401403404408409413
GET
/api/v2/socialmedia/topics/{topicId}
Get a single social topic.
getSocialmediaTopic 2 params → 200400401403404408409413
DELETE
/api/v2/socialmedia/topics/{topicId}
Delete a social topic.
deleteSocialmediaTopic 2 params → 204400401403404408409413
PATCH
/api/v2/socialmedia/topics/{topicId}
Update a social topic.
patchSocialmediaTopic 2 params → 200400401403404408409413
GET
/api/v2/socialmedia/topics
Retrieve all social topics.
getSocialmediaTopics 6 params → 200400401403404408409413
POST
/api/v2/socialmedia/topics
Create a social topic.
postSocialmediaTopics 1 param → 200400401403404408409413

Schemas 130

The contract defines 130 schemas that model the data the API accepts and returns. The most detailed are ConversationMessageContent (20 properties), SocialMediaStatisticalSummary (16 properties), EscalationRuleResponse (15 properties), ConversationNormalizedMessage (15 properties). Each schema is shown below with its type and property counts.

OpenSocialReactionsNormalizedEventEntityListing
object
10 properties
AsyncQueryStatus
object
5 properties
ConversationNormalizedMessage
object
General rich media message structure with normalized feature support across many messaging channels.
15 properties 1 required
ConversationContentRequiredContactField
object
Contact fields a merchant requires to complete a payment request.
1 property 1 required
ConversationContentDatePickerAvailableTime
object
A datetimepicker available time that a user can take.
2 properties
ConversationContentQuickReplyV2
object
Quick reply object V2.
2 properties 2 required
OpenDataIngestionRuleVersionResponse
object
12 properties
ConversationEnrichment
object
Metadata enrichments provided by the platform.
2 properties
ConversationEnrichmentSentimentV2
object
Sentiment analysis of this message.
1 property 1 required
SocialMediaAggregateMetricData
object
3 properties
ConversationContentCardAction
object
A card action that a user can take.
4 properties
InstagramDataIngestionRuleVersionResponse
object
12 properties
ConversationContentCarousel
object
Carousel content object.
1 property 1 required
ConversationContentButtonResponse
object
Button response object representing the click of a structured message button, such as a quick reply.
4 properties 2 required
ManualEscalationRequest
object
2 properties 1 required
OpenDataIngestionRuleResponse
object
12 properties
ConversationContentStory
object
An ephemeral story.
3 properties
ConversationNotificationTemplateBody
object
Template body object.
2 properties 1 required
ConversationContentIntroduction
object
Introduction content object.
4 properties 2 required
TwitterDataIngestionRuleVersionResponse
object
12 properties
SocialTopicWithDataIngestionRuleMetadataResponseEntityListing
object
10 properties
ConversationNotificationTemplateFooter
object
Template footer object.
1 property
SocialMediaDetailDataContainer
object
2 properties
ConversationContentNotificationTemplate
object
Template notification object.
6 properties 1 required
ConversationChannelMetadata
object
Information about the channel.
1 property
TwitterDataIngestionRuleResponse
object
12 properties
ConversationContentPaymentRequest
object
Payment Request object used to request payment from a customer.
9 properties 4 required
ConversationContentPaymentResponse
object
Payment response object representing the status of a payment transaction.
3 properties 2 required
EscalationTarget
object
3 properties 2 required
SocialMediaAsyncDetailQuery
object
5 properties 1 required
ConversationNotificationTemplateButton
object
Template button object
7 properties 2 required
ManualEscalationResponse
object
4 properties
AsyncQueryResponse
object
1 property
ConversationFormResponseComponent
object
A response component from a form
2 properties 2 required
SocialMediaDetailMessageContainer
object
4 properties
ConversationContentInteractiveApplication
object
InteractiveApplication content object.
4 properties
TwitterDataIngestionRuleRequest
object
4 properties 2 required
ConversationFormPage
object
Form page object.
3 properties 2 required
TweetUsage
object
3 properties
OpenSocialMediaReactionsChannel
object
Channel-specific information that describes the message and the message channel/provider.
6 properties 2 required
ConversationEnrichmentLanguage
object
Detected language of this message.
1 property 1 required
OpenDataIngestionRuleVersionResponseEntityListing
object
10 properties
ConversationContentDatePicker
object
DateTimePicker content object.
9 properties
SocialMediaStatisticalResponse
object
2 properties
SocialMediaAsyncDetailQueryResponse
object
2 properties
OpenSocialMediaChannel
object
Channel-specific information that describes the message and the message channel/provider.
9 properties 4 required
ConversationContentText
object
Message content element containing text only.
2 properties 1 required
ConversationContentWheelPicker
object
Wheel Picker object for representing single selection of selectable items.
2 properties 1 required
SocialMediaQueryFilter
object
3 properties 1 required
OpenSocialMediaMessageContent
object
Message content element.
4 properties 1 required
NumericRange
object
4 properties
ConversationContentNotificationResponse
object
Inbound response to a notification, such as an Apple Invitations acceptance.
4 properties 2 required
ConversationEventVideo
object
A Video event.
3 properties 1 required
SocialTopicWithDataIngestionRuleMetadataResponse
object
9 properties
DomainEntityRef
object
3 properties
ConversationMessagingToRecipient
object
Information about the recipient the message is sent to.
9 properties 1 required
InstagramDataIngestionRuleResponse
object
12 properties
ConversationContentWheelPickerItem
object
Represents a selectable item in a Wheel Picker
3 properties 2 required
SocialMediaMessageEscalationInfo
object
1 property
ConversationMessageEvent
object
Message event element. Examples include: system messages, typing indicators, cobrowse offerings.
5 properties 1 required
OpenSocialMediaReactionsNormalizedEvent
object
Open Social Messaging rich media event structure
4 properties 2 required
SocialMediaQueryClause
object
2 properties 2 required
ConversationEventTyping
object
A Typing event.
2 properties 1 required
ConversationPushProviderIntegration
object
A Push provider integration.
2 properties 2 required
Detail
object
4 properties
TwitterDataHistoricalTweetResponse
object
3 properties
FacebookDataIngestionRuleResponse
object
12 properties
SocialTopicRequest
object
3 properties 2 required
ConversationContentLocation
object
Location object.
5 properties
ConversationContentInput
object
Single or multiline text input component.
8 properties 2 required
ConversationEventPresence
object
A Presence event.
3 properties 1 required
ConversationContentLineItem
object
Item included in an order.
4 properties 2 required
OpenSocialMediaReactionsRequest
object
1 property 1 required
OpenSocialMediaNormalizedMessage
object
Open Social Messaging rich media message structure
7 properties 1 required
ConversationFormResponseContent
object
Message content element for form responses
2 properties
OverrideEscalationTarget
object
1 property 1 required
OpenSocialMediaPublicMetadata
object
Information about a public message.
6 properties 1 required
OpenSocialMediaRecipientAdditionalIdentifier
object
2 properties 2 required
ContentModeration
object
2 properties 1 required
ConversationContentListPicker
object
List Picker object for presenting multiple sections of selectable items.
4 properties
SocialMediaAsyncAggregateQueryResponse
object
2 properties
ConversationContentReceivedReplyMessage
object
ReceivedReplyMessage content object.
5 properties
Limit
object
3 properties
DataIngestionRulesMetadata
object
3 properties
ContentReaction
object
User reaction to public message.
2 properties 2 required
MessageInfo
object
4 properties
ConversationContentQuickReply
object
Quick reply object.
5 properties 2 required
ConversationPublicMetadata
object
Information about a public message.
3 properties
ConversationMessagingChannel
object
Channel-specific information that describes the message and the message channel/provider.
10 properties
FacebookDataIngestionRuleVersionResponseEntityListing
object
10 properties
DataIngestionRuleResponse
object
11 properties
ConversationContentAttachment
object
Attachment object.
8 properties 1 required
SocialMediaQueryPredicate
object
5 properties
EscalationRuleRequest
object
11 properties 4 required
ConversationRecipientAdditionalIdentifier
object
Additional identifiers for describing messaging recipient.
2 properties 2 required
ConversationNotificationTemplateParameter
object
Template parameters for placeholders in template.
2 properties 1 required
ConversationEventCoBrowse
object
A CoBrowse event.
3 properties 1 required
ConversationPushFailedMessageReferences
object
References of failed messages requiring a push.
1 property 1 required
OpenSocialMediaReactionsEvent
object
Social Message event element.
1 property 1 required
ConversationContentListPickerSection
object
List Picker object for presenting a section of selectable items.
3 properties
ConversationPushNotificationMessageLabel
object
A Push notification message label.
2 properties 2 required
ConversationContentCard
object
Card content object.
6 properties 2 required
OpenSocialMediaRecipient
object
Information about the recipient the message is sent to or received from.
7 properties 1 required
ConversationContentReaction
object
User reaction to public message.
2 properties 1 required
ConversationNotificationTemplateHeader
object
Template header object.
4 properties 1 required
ConversationReason
object
Reasons for a failed message receipt.
2 properties 1 required
ConversationContentListPickerItem
object
Represents a selectable item in a list picker.
4 properties
ConversationContentForm
object
Form content object.
8 properties 1 required
ErrorBody
object
11 properties
EscalationRuleResponse
object
15 properties 2 required
ConversationContentPush
object
A Push object
7 properties 7 required
SocialMediaAggregateDataContainer
object
2 properties
TwitterDataHistoricalTweetRequest
object
2 properties 1 required
SocialMediaAsyncAggregationQuery
object
7 properties 2 required
SocialMediaStatisticalSummary
object
16 properties
DataIngestionRuleStatusPatchRequest
object
1 property 1 required
SocialEscalationResponseEntityListing
object
10 properties
ConversationMessageContent
object
Message content element. If contentType = "Attachment" only one item is allowed.
20 properties 1 required
TwitterDataIngestionRuleVersionResponseEntityListing
object
10 properties
FacebookDataIngestionRuleRequest
object
3 properties 1 required
ConversationFormPageComponent
object
Form component element. Examples include: List Picker, Date Picker, Wheel Picker and Input text.
5 properties
OpenDataIngestionRuleRequest
object
3 properties 2 required
SocialTopicPatchRequest
object
3 properties
FacebookDataIngestionRuleVersionResponse
object
12 properties
DataIngestionRuleResponseEntityListing
object
10 properties
SocialTopicResponse
object
8 properties
InstagramDataIngestionRuleRequest
object
3 properties 2 required
OpenSocialNormalizedMessageEntityListing
object
10 properties
InstagramDataIngestionRuleVersionResponseEntityListing
object
10 properties
ConversationMessagingFromRecipient
object
Information about the recipient the message is received from.
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-social-media-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 Social Media 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.