Skip to main content
Server path: /genesys-content | Type: Application | PCID required: Yes

Tools

ToolDescription
genesys_content_delete_contentmanagement_documentDelete a document.
genesys_content_delete_contentmanagement_shareDeletes an existing share.
genesys_content_delete_contentmanagement_status_status_idCancel the command for this status
genesys_content_delete_contentmanagement_workspaceDelete a workspace
genesys_content_delete_contentmanagement_workspace_memberDelete a member from a workspace
genesys_content_delete_contentmanagement_workspace_tagvalueDelete workspace tag
genesys_content_delete_responsemanagement_libraryDelete an existing response library.
genesys_content_delete_responsemanagement_responseDelete an existing response.
genesys_content_delete_responsemanagement_responseassetDelete response asset
genesys_content_get_contentmanagement_documentGet a document.
genesys_content_get_contentmanagement_document_contentDownload a document.
genesys_content_get_contentmanagement_queryQuery content
genesys_content_get_contentmanagement_securityprofileGet a Security Profile
genesys_content_get_contentmanagement_securityprofilesGet a List of Security Profiles
genesys_content_get_contentmanagement_shareRetrieve details about an existing share.
genesys_content_get_contentmanagement_shared_shared_idGet shared documents. Securely download a shared document.
genesys_content_get_contentmanagement_sharesGets a list of shares. You must specify at least one filter (e.g. entityId).
genesys_content_get_contentmanagement_statusGet a list of statuses for pending operations
genesys_content_get_contentmanagement_status_status_idGet a status.
genesys_content_get_contentmanagement_usageGet usage details.
genesys_content_get_contentmanagement_workspaceGet a workspace.
genesys_content_get_contentmanagement_workspace_documentsGet a list of documents.
genesys_content_get_contentmanagement_workspace_memberGet a workspace member
genesys_content_get_contentmanagement_workspace_membersGet a list workspace members
genesys_content_get_contentmanagement_workspace_tagvalueGet a workspace tag
genesys_content_get_contentmanagement_workspace_tagvaluesGet a list of workspace tags
genesys_content_get_contentmanagement_workspacesGet a list of workspaces.
genesys_content_get_responsemanagement_librariesGets a list of existing response libraries.
genesys_content_get_responsemanagement_libraryGet details about an existing response library.
genesys_content_get_responsemanagement_responseGet details about an existing response.
genesys_content_get_responsemanagement_responseassetGet response asset information
genesys_content_get_responsemanagement_responseassets_status_status_idGet response asset upload status
genesys_content_get_responsemanagement_responsesGets a list of existing responses.
genesys_content_post_contentmanagement_documentUpdate a document.
genesys_content_post_contentmanagement_document_contentReplace the contents of a document.
genesys_content_post_contentmanagement_documentsAdd a document.
genesys_content_post_contentmanagement_queryQuery content
genesys_content_post_contentmanagement_sharesCreates a new share or updates an existing share if the entity has already been shared
genesys_content_post_contentmanagement_workspace_tagvaluesCreate a workspace tag
genesys_content_post_contentmanagement_workspace_tagvalues_queryPerform a prefix query on tags in the workspace
genesys_content_post_contentmanagement_workspacesCreate a group workspace
genesys_content_post_responsemanagement_librariesCreate a response library.
genesys_content_post_responsemanagement_responseassets_searchSearch response assets
genesys_content_post_responsemanagement_responseassets_uploadsCreates pre-signed url for uploading response asset
genesys_content_post_responsemanagement_responsesCreate a response.
genesys_content_post_responsemanagement_responses_queryQuery responses
genesys_content_put_contentmanagement_workspaceUpdate a workspace
genesys_content_put_contentmanagement_workspace_memberAdd a member to a workspace
genesys_content_put_contentmanagement_workspace_tagvalueUpdate a workspace tag. Will update all documents with the new tag value.
genesys_content_put_responsemanagement_libraryUpdate an existing response library.
genesys_content_put_responsemanagement_responseUpdate an existing response.
genesys_content_put_responsemanagement_responseassetUpdate response asset

genesys_content_delete_contentmanagement_document

Delete a document. Parameters:
ParameterTypeRequiredDefaultDescription
documentIdstringYesDocument ID
overridebooleanNoOverride any lock on the document

genesys_content_delete_contentmanagement_share

Deletes an existing share. Parameters:
ParameterTypeRequiredDefaultDescription
shareIdstringYesShare ID

genesys_content_delete_contentmanagement_status_status_id

Cancel the command for this status Parameters:
ParameterTypeRequiredDefaultDescription
statusIdstringYesStatus ID

genesys_content_delete_contentmanagement_workspace

Delete a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
moveChildrenToWorkspaceIdstringNoNew location for objects in deleted workspace.

genesys_content_delete_contentmanagement_workspace_member

Delete a member from a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
memberIdstringYesMember ID

genesys_content_delete_contentmanagement_workspace_tagvalue

Delete workspace tag Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
tagIdstringYesTag ID

genesys_content_delete_responsemanagement_library

Delete an existing response library. Parameters:
ParameterTypeRequiredDefaultDescription
libraryIdstringYesLibrary ID

genesys_content_delete_responsemanagement_response

Delete an existing response. Parameters:
ParameterTypeRequiredDefaultDescription
responseIdstringYesResponse ID

genesys_content_delete_responsemanagement_responseasset

Delete response asset Parameters:
ParameterTypeRequiredDefaultDescription
responseAssetIdstringYesAsset Id

genesys_content_get_contentmanagement_document

Get a document. Parameters:
ParameterTypeRequiredDefaultDescription
documentIdstringYesDocument ID
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_contentmanagement_document_content

Download a document. Parameters:
ParameterTypeRequiredDefaultDescription
documentIdstringYesDocument ID
dispositionstringNoRequest how the content will be downloaded: a file attachment or inline. Default is attachment.
contentTypestringNoThe requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav

genesys_content_get_contentmanagement_query

Query content Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortBystringNoname or dateCreated
sortOrderstringNoascending or descending
queryPhrasestringYesPhrase tokens are ANDed together over all searchable fields
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_contentmanagement_securityprofile

Get a Security Profile Parameters:
ParameterTypeRequiredDefaultDescription
securityProfileIdstringYesSecurity Profile Id

genesys_content_get_contentmanagement_securityprofiles

Get a List of Security Profiles

genesys_content_get_contentmanagement_share

Retrieve details about an existing share. Parameters:
ParameterTypeRequiredDefaultDescription
shareIdstringYesShare ID
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_contentmanagement_shared_shared_id

Get shared documents. Securely download a shared document. Parameters:
ParameterTypeRequiredDefaultDescription
sharedIdstringYesShared ID
dispositionstringNoRequest how the share content will be downloaded: attached as a file or inline. Default is attachment.
contentTypestringNoThe requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
expandstringNoExpand some document fields

genesys_content_get_contentmanagement_shares

Gets a list of shares. You must specify at least one filter (e.g. entityId). Parameters:
ParameterTypeRequiredDefaultDescription
entityIdstringNoFilters the shares returned to only the entity specified by the value of this parameter.
expandany[]NoWhich fields, if any, to expand.
pageSizeintegerNoPage size
pageNumberintegerNoPage number

genesys_content_get_contentmanagement_status

Get a list of statuses for pending operations Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number

genesys_content_get_contentmanagement_status_status_id

Get a status. Parameters:
ParameterTypeRequiredDefaultDescription
statusIdstringYesStatus ID

genesys_content_get_contentmanagement_usage

Get usage details.

genesys_content_get_contentmanagement_workspace

Get a workspace. Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_contentmanagement_workspace_documents

Get a list of documents. Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
expandany[]NoWhich fields, if any, to expand.
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortBystringNoname or dateCreated
sortOrderstringNoascending or descending

genesys_content_get_contentmanagement_workspace_member

Get a workspace member Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
memberIdstringYesMember ID
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_contentmanagement_workspace_members

Get a list workspace members Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_contentmanagement_workspace_tagvalue

Get a workspace tag Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
tagIdstringYesTag ID
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_contentmanagement_workspace_tagvalues

Get a list of workspace tags Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
valuestringNofilter the list of tags returned
pageSizeintegerNoPage size
pageNumberintegerNoPage number
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_contentmanagement_workspaces

Get a list of workspaces. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
accessany[]NoRequested access level.
expandany[]NoWhich fields, if any, to expand.

genesys_content_get_responsemanagement_libraries

Gets a list of existing response libraries. Parameters:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoPage number
pageSizeintegerNoPage size
messagingTemplateFilterstringNoReturns a list of libraries that contain responses with at least one messaging template defined for a specific message channel
libraryPrefixstringNoReturns a list of libraries that contain the prefix provided

genesys_content_get_responsemanagement_library

Get details about an existing response library. Parameters:
ParameterTypeRequiredDefaultDescription
libraryIdstringYesLibrary ID

genesys_content_get_responsemanagement_response

Get details about an existing response. Parameters:
ParameterTypeRequiredDefaultDescription
responseIdstringYesResponse ID
expandstringNoExpand instructions for the return value.

genesys_content_get_responsemanagement_responseasset

Get response asset information Parameters:
ParameterTypeRequiredDefaultDescription
responseAssetIdstringYesAsset Id

genesys_content_get_responsemanagement_responseassets_status_status_id

Get response asset upload status Parameters:
ParameterTypeRequiredDefaultDescription
statusIdstringYesStatus Id

genesys_content_get_responsemanagement_responses

Gets a list of existing responses. Parameters:
ParameterTypeRequiredDefaultDescription
libraryIdstringYesLibrary ID
pageNumberintegerNoPage number
pageSizeintegerNoPage size
expandstringNoExpand instructions for the return value.

genesys_content_post_contentmanagement_document

Update a document. Parameters:
ParameterTypeRequiredDefaultDescription
documentIdstringYesDocument ID
expandstringNoExpand some document fields
overridebooleanNoOverride any lock on the document
addTagIdsany[]NoaddTagIds
addTagsany[]NoaddTags
changeNumberintegerNochangeNumber
namestringYesThe name of the document
readbooleanNoread
removeAttributesany[]NoremoveAttributes
removeTagIdsany[]NoremoveTagIds
removeTagsany[]NoremoveTags
updateAttributesany[]NoupdateAttributes

genesys_content_post_contentmanagement_document_content

Replace the contents of a document. Parameters:
ParameterTypeRequiredDefaultDescription
documentIdstringYesDocument ID
overridebooleanNoOverride any lock on the document
authTokenstringNoauthToken
changeNumberintegerNochangeNumber
namestringNoname

genesys_content_post_contentmanagement_documents

Add a document. Parameters:
ParameterTypeRequiredDefaultDescription
copySourcestringNoCopy a document within a workspace or to a new workspace. Provide a document ID as the copy source.
moveSourcestringNoMove a document to a new workspace. Provide a document ID as the move source.
overridebooleanNoOverride any lock on the source document
namestringYesThe name of the document
tagIdsany[]NotagIds
tagsany[]Notags
workspaceobjectYesworkspace

genesys_content_post_contentmanagement_query

Query content Parameters:
ParameterTypeRequiredDefaultDescription
expandstringNoExpand some document fields
attributeFiltersany[]NoattributeFilters
facetNameRequestsany[]NofacetNameRequests
filtersany[]Nofilters
includeSharesbooleanNoincludeShares
pageNumberintegerNopageNumber
pageSizeintegerNopageSize
queryPhrasestringNoqueryPhrase
sortany[]Nosort

genesys_content_post_contentmanagement_shares

Creates a new share or updates an existing share if the entity has already been shared Parameters:
ParameterTypeRequiredDefaultDescription
memberobjectNomember
membersany[]Nomembers
memberTypestringNomemberType
sharedEntityobjectYessharedEntity
sharedEntityTypestringYesThe share entity type

genesys_content_post_contentmanagement_workspace_tagvalues

Create a workspace tag Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
aclany[]Noacl
idstringNoThe globally unique identifier for the object.
inUsebooleanNoinUse
namestringYesThe workspace tag name.
selfUristringNoThe URI for this object

genesys_content_post_contentmanagement_workspace_tagvalues_query

Perform a prefix query on tags in the workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
expandany[]NoWhich fields, if any, to expand.
pageNumberintegerNopageNumber
pageSizeintegerNopageSize
querystringNoquery

genesys_content_post_contentmanagement_workspaces

Create a group workspace Parameters:
ParameterTypeRequiredDefaultDescription
bucketstringNobucket
descriptionstringNodescription
namestringYesThe workspace name

genesys_content_post_responsemanagement_libraries

Create a response library. Parameters:
ParameterTypeRequiredDefaultDescription
createdByobjectNocreatedBy
dateCreatedstringNoThe date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
idstringNoThe globally unique identifier for the object.
namestringYesThe library name.
responseTypestringNoThis value is deprecated. Responses representing message templates may be added to any library.
selfUristringNoThe URI for this object
versionintegerNoCurrent version for this resource.

genesys_content_post_responsemanagement_responseassets_search

Search response assets Parameters:
ParameterTypeRequiredDefaultDescription
expandany[]NoWhich fields, if any, to expand
pageNumberintegerNoThe page of resources you want to retrieve
pageSizeintegerNoThe number of results per page. Default: 25, Maximum: 100.
queryany[]YesFilter the query results.
sortBystringNoThe field in the resource that you want to sort the results by
sortOrderstringNoThe sort order for results

genesys_content_post_responsemanagement_responseassets_uploads

Creates pre-signed url for uploading response asset Parameters:
ParameterTypeRequiredDefaultDescription
contentMd5stringNoContent MD-5 of the file to upload
divisionIdstringNoDivision to associate to this asset. Can only be used with this division.
namestringYesName of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: &#123;^}%`]”>[~<#|

genesys_content_post_responsemanagement_responses

Create a response. Parameters:
ParameterTypeRequiredDefaultDescription
expandstringNoExpand instructions for the return value.
assetsany[]NoAssets used in the response
createdByobjectNocreatedBy
dateCreatedstringNoThe date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
footerobjectNoThe Footer template identifies the Footer type and its footerUsage
idstringNoThe globally unique identifier for the object.
interactionTypestringNoThe interaction type for this response.
librariesany[]YesOne or more libraries response is associated with.
messagingTemplateobjectNoThe messaging template identifies a structured message templates supported by a messaging channel.
namestringNoname
responseTypestringNoThe response type represented by the response.
selfUristringNoThe URI for this object
substitutionsany[]NoDetails about any text substitutions used in the texts for this response.
substitutionsSchemaobjectNoA JSON Schema document.
textsany[]YesOne or more texts associated with the response.
versionintegerNoVersion number required for updates.

genesys_content_post_responsemanagement_responses_query

Query responses Parameters:
ParameterTypeRequiredDefaultDescription
filtersany[]NoFilter the query results.
pageNumberintegerNoPage Number
pageSizeintegerNoThe maximum number of hits to return. Default: 25, Maximum: 500.
queryPhrasestringNoQuery phrase to search response text and name. If not set will match all.

genesys_content_put_contentmanagement_workspace

Update a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
aclany[]Noacl
bucketstringNobucket
dateCreatedstringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
dateModifiedstringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
descriptionstringNodescription
idstringNoThe globally unique identifier for the object.
isCurrentUserWorkspacebooleanNoisCurrentUserWorkspace
namestringYesThe current name of the workspace.
selfUristringNoThe URI for this object
summaryobjectNosummary
typestringNotype
userobjectNouser

genesys_content_put_contentmanagement_workspace_member

Add a member to a workspace Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
memberIdstringYesMember ID
groupobjectNogroup
idstringNoThe globally unique identifier for the object.
memberobjectNomember
memberTypestringYesThe workspace member type.
namestringNoname
securityProfileobjectNosecurityProfile
selfUristringNoThe URI for this object
userobjectNouser
workspaceobjectNoworkspace

genesys_content_put_contentmanagement_workspace_tagvalue

Update a workspace tag. Will update all documents with the new tag value. Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace ID
tagIdstringYesTag ID
aclany[]Noacl
idstringNoThe globally unique identifier for the object.
inUsebooleanNoinUse
namestringYesThe workspace tag name.
selfUristringNoThe URI for this object

genesys_content_put_responsemanagement_library

Update an existing response library. Parameters:
ParameterTypeRequiredDefaultDescription
libraryIdstringYesLibrary ID
createdByobjectNocreatedBy
dateCreatedstringNoThe date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
idstringNoThe globally unique identifier for the object.
namestringYesThe library name.
responseTypestringNoThis value is deprecated. Responses representing message templates may be added to any library.
selfUristringNoThe URI for this object
versionintegerNoCurrent version for this resource.

genesys_content_put_responsemanagement_response

Update an existing response. Parameters:
ParameterTypeRequiredDefaultDescription
responseIdstringYesResponse ID
expandstringNoExpand instructions for the return value.
assetsany[]NoAssets used in the response
createdByobjectNocreatedBy
dateCreatedstringNoThe date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
footerobjectNoThe Footer template identifies the Footer type and its footerUsage
idstringNoThe globally unique identifier for the object.
interactionTypestringNoThe interaction type for this response.
librariesany[]YesOne or more libraries response is associated with.
messagingTemplateobjectNoThe messaging template identifies a structured message templates supported by a messaging channel.
namestringNoname
responseTypestringNoThe response type represented by the response.
selfUristringNoThe URI for this object
substitutionsany[]NoDetails about any text substitutions used in the texts for this response.
substitutionsSchemaobjectNoA JSON Schema document.
textsany[]YesOne or more texts associated with the response.
versionintegerNoVersion number required for updates.

genesys_content_put_responsemanagement_responseasset

Update response asset Parameters:
ParameterTypeRequiredDefaultDescription
responseAssetIdstringYesAsset Id
divisionIdstringNoDivision to associate to this asset. Can only be used with this division.
namestringYesName of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: &#123;^}%`]”>[~<#|