> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # genesys-content > Genesys Content - document and workspace management, canned response libraries **Server path:** `/genesys-content` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | [`genesys_content_delete_contentmanagement_document`](#genesys_content_delete_contentmanagement_document) | Delete a document. | | [`genesys_content_delete_contentmanagement_share`](#genesys_content_delete_contentmanagement_share) | Deletes an existing share. | | [`genesys_content_delete_contentmanagement_status_status_id`](#genesys_content_delete_contentmanagement_status_status_id) | Cancel the command for this status | | [`genesys_content_delete_contentmanagement_workspace`](#genesys_content_delete_contentmanagement_workspace) | Delete a workspace | | [`genesys_content_delete_contentmanagement_workspace_member`](#genesys_content_delete_contentmanagement_workspace_member) | Delete a member from a workspace | | [`genesys_content_delete_contentmanagement_workspace_tagvalue`](#genesys_content_delete_contentmanagement_workspace_tagvalue) | Delete workspace tag | | [`genesys_content_delete_responsemanagement_library`](#genesys_content_delete_responsemanagement_library) | Delete an existing response library. | | [`genesys_content_delete_responsemanagement_response`](#genesys_content_delete_responsemanagement_response) | Delete an existing response. | | [`genesys_content_delete_responsemanagement_responseasset`](#genesys_content_delete_responsemanagement_responseasset) | Delete response asset | | [`genesys_content_get_contentmanagement_document`](#genesys_content_get_contentmanagement_document) | Get a document. | | [`genesys_content_get_contentmanagement_document_content`](#genesys_content_get_contentmanagement_document_content) | Download a document. | | [`genesys_content_get_contentmanagement_query`](#genesys_content_get_contentmanagement_query) | Query content | | [`genesys_content_get_contentmanagement_securityprofile`](#genesys_content_get_contentmanagement_securityprofile) | Get a Security Profile | | [`genesys_content_get_contentmanagement_securityprofiles`](#genesys_content_get_contentmanagement_securityprofiles) | Get a List of Security Profiles | | [`genesys_content_get_contentmanagement_share`](#genesys_content_get_contentmanagement_share) | Retrieve details about an existing share. | | [`genesys_content_get_contentmanagement_shared_shared_id`](#genesys_content_get_contentmanagement_shared_shared_id) | Get shared documents. Securely download a shared document. | | [`genesys_content_get_contentmanagement_shares`](#genesys_content_get_contentmanagement_shares) | Gets a list of shares. You must specify at least one filter (e.g. entityId). | | [`genesys_content_get_contentmanagement_status`](#genesys_content_get_contentmanagement_status) | Get a list of statuses for pending operations | | [`genesys_content_get_contentmanagement_status_status_id`](#genesys_content_get_contentmanagement_status_status_id) | Get a status. | | [`genesys_content_get_contentmanagement_usage`](#genesys_content_get_contentmanagement_usage) | Get usage details. | | [`genesys_content_get_contentmanagement_workspace`](#genesys_content_get_contentmanagement_workspace) | Get a workspace. | | [`genesys_content_get_contentmanagement_workspace_documents`](#genesys_content_get_contentmanagement_workspace_documents) | Get a list of documents. | | [`genesys_content_get_contentmanagement_workspace_member`](#genesys_content_get_contentmanagement_workspace_member) | Get a workspace member | | [`genesys_content_get_contentmanagement_workspace_members`](#genesys_content_get_contentmanagement_workspace_members) | Get a list workspace members | | [`genesys_content_get_contentmanagement_workspace_tagvalue`](#genesys_content_get_contentmanagement_workspace_tagvalue) | Get a workspace tag | | [`genesys_content_get_contentmanagement_workspace_tagvalues`](#genesys_content_get_contentmanagement_workspace_tagvalues) | Get a list of workspace tags | | [`genesys_content_get_contentmanagement_workspaces`](#genesys_content_get_contentmanagement_workspaces) | Get a list of workspaces. | | [`genesys_content_get_responsemanagement_libraries`](#genesys_content_get_responsemanagement_libraries) | Gets a list of existing response libraries. | | [`genesys_content_get_responsemanagement_library`](#genesys_content_get_responsemanagement_library) | Get details about an existing response library. | | [`genesys_content_get_responsemanagement_response`](#genesys_content_get_responsemanagement_response) | Get details about an existing response. | | [`genesys_content_get_responsemanagement_responseasset`](#genesys_content_get_responsemanagement_responseasset) | Get response asset information | | [`genesys_content_get_responsemanagement_responseassets_status_status_id`](#genesys_content_get_responsemanagement_responseassets_status_status_id) | Get response asset upload status | | [`genesys_content_get_responsemanagement_responses`](#genesys_content_get_responsemanagement_responses) | Gets a list of existing responses. | | [`genesys_content_post_contentmanagement_document`](#genesys_content_post_contentmanagement_document) | Update a document. | | [`genesys_content_post_contentmanagement_document_content`](#genesys_content_post_contentmanagement_document_content) | Replace the contents of a document. | | [`genesys_content_post_contentmanagement_documents`](#genesys_content_post_contentmanagement_documents) | Add a document. | | [`genesys_content_post_contentmanagement_query`](#genesys_content_post_contentmanagement_query) | Query content | | [`genesys_content_post_contentmanagement_shares`](#genesys_content_post_contentmanagement_shares) | Creates a new share or updates an existing share if the entity has already been shared | | [`genesys_content_post_contentmanagement_workspace_tagvalues`](#genesys_content_post_contentmanagement_workspace_tagvalues) | Create a workspace tag | | [`genesys_content_post_contentmanagement_workspace_tagvalues_query`](#genesys_content_post_contentmanagement_workspace_tagvalues_query) | Perform a prefix query on tags in the workspace | | [`genesys_content_post_contentmanagement_workspaces`](#genesys_content_post_contentmanagement_workspaces) | Create a group workspace | | [`genesys_content_post_responsemanagement_libraries`](#genesys_content_post_responsemanagement_libraries) | Create a response library. | | [`genesys_content_post_responsemanagement_libraries_query`](#genesys_content_post_responsemanagement_libraries_query) | Query libraries using criteria. Users can set DivisionId parameter as '\*' to fetch libraries that aren't associated with any divisions. | | [`genesys_content_post_responsemanagement_responseassets_search`](#genesys_content_post_responsemanagement_responseassets_search) | Search response assets | | [`genesys_content_post_responsemanagement_responseassets_uploads`](#genesys_content_post_responsemanagement_responseassets_uploads) | Creates pre-signed url for uploading response asset | | [`genesys_content_post_responsemanagement_responses`](#genesys_content_post_responsemanagement_responses) | Create a response. | | [`genesys_content_post_responsemanagement_responses_query`](#genesys_content_post_responsemanagement_responses_query) | Query responses | | [`genesys_content_put_contentmanagement_workspace`](#genesys_content_put_contentmanagement_workspace) | Update a workspace | | [`genesys_content_put_contentmanagement_workspace_member`](#genesys_content_put_contentmanagement_workspace_member) | Add a member to a workspace | | [`genesys_content_put_contentmanagement_workspace_tagvalue`](#genesys_content_put_contentmanagement_workspace_tagvalue) | Update a workspace tag. Will update all documents with the new tag value. | | [`genesys_content_put_responsemanagement_library`](#genesys_content_put_responsemanagement_library) | Update an existing response library. | | [`genesys_content_put_responsemanagement_response`](#genesys_content_put_responsemanagement_response) | Update an existing response. | | [`genesys_content_put_responsemanagement_responseasset`](#genesys_content_put_responsemanagement_responseasset) | Update response asset | *** ## genesys\_content\_delete\_contentmanagement\_document Delete a document. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | --------------------------------- | | `documentId` | string | Yes | — | Document ID | | `override` | boolean | No | — | Override any lock on the document | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentId": { "type": "string", "description": "Document ID" }, "override": { "type": "boolean", "description": "Override any lock on the document" } }, "required": [ "PCID", "documentId" ] } ``` *** ## genesys\_content\_delete\_contentmanagement\_share Deletes an existing share. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `shareId` | string | Yes | — | Share ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "shareId": { "type": "string", "description": "Share ID" } }, "required": [ "PCID", "shareId" ] } ``` *** ## genesys\_content\_delete\_contentmanagement\_status\_status\_id Cancel the command for this status **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `statusId` | string | Yes | — | Status ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "statusId": { "type": "string", "description": "Status ID" } }, "required": [ "PCID", "statusId" ] } ``` *** ## genesys\_content\_delete\_contentmanagement\_workspace Delete a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------ | -------- | ------- | ---------------------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `moveChildrenToWorkspaceId` | string | No | — | New location for objects in deleted workspace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "moveChildrenToWorkspaceId": { "type": "string", "description": "New location for objects in deleted workspace." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## genesys\_content\_delete\_contentmanagement\_workspace\_member Delete a member from a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------ | | `workspaceId` | string | Yes | — | Workspace ID | | `memberId` | string | Yes | — | Member ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "memberId": { "type": "string", "description": "Member ID" } }, "required": [ "PCID", "workspaceId", "memberId" ] } ``` *** ## genesys\_content\_delete\_contentmanagement\_workspace\_tagvalue Delete workspace tag **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------ | | `workspaceId` | string | Yes | — | Workspace ID | | `tagId` | string | Yes | — | Tag ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "tagId": { "type": "string", "description": "Tag ID" } }, "required": [ "PCID", "workspaceId", "tagId" ] } ``` *** ## genesys\_content\_delete\_responsemanagement\_library Delete an existing response library. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `libraryId` | string | Yes | — | Library ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryId": { "type": "string", "description": "Library ID" } }, "required": [ "PCID", "libraryId" ] } ``` *** ## genesys\_content\_delete\_responsemanagement\_response Delete an existing response. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------- | | `responseId` | string | Yes | — | Response ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "responseId": { "type": "string", "description": "Response ID" } }, "required": [ "PCID", "responseId" ] } ``` *** ## genesys\_content\_delete\_responsemanagement\_responseasset Delete response asset **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------- | | `responseAssetId` | string | Yes | — | Asset Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "responseAssetId": { "type": "string", "description": "Asset Id" } }, "required": [ "PCID", "responseAssetId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_document Get a document. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | -------------------------------- | | `documentId` | string | Yes | — | Document ID | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentId": { "type": "string", "description": "Document ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "lockInfo", "acl", "workspace" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID", "documentId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_document\_content Download a document. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `documentId` | string | Yes | — | Document ID | | `disposition` | string | No | — | Request how the content will be downloaded: a file attachment or inline. Default is attachment. | | `contentType` | string | No | — | The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentId": { "type": "string", "description": "Document ID" }, "disposition": { "type": "string", "description": "Request how the content will be downloaded: a file attachment or inline. Default is attachment.", "enum": [ "attachment", "inline" ] }, "contentType": { "type": "string", "description": "The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav" } }, "required": [ "PCID", "documentId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_query Query content **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ----------------------------------------------------------- | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `sortBy` | string | No | — | name or dateCreated | | `sortOrder` | string | No | — | ascending or descending | | `queryPhrase` | string | Yes | — | Phrase tokens are ANDed together over all searchable fields | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "sortBy": { "type": "string", "description": "name or dateCreated" }, "sortOrder": { "type": "string", "description": "ascending or descending" }, "queryPhrase": { "type": "string", "description": "Phrase tokens are ANDed together over all searchable fields" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "acl", "workspace" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID", "queryPhrase" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_securityprofile Get a Security Profile **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ------------------- | | `securityProfileId` | string | Yes | — | Security Profile Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "securityProfileId": { "type": "string", "description": "Security Profile Id" } }, "required": [ "PCID", "securityProfileId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_securityprofiles Get a List of Security Profiles ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_share Retrieve details about an existing share. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | -------------------------------- | | `shareId` | string | Yes | — | Share ID | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "shareId": { "type": "string", "description": "Share ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "member" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID", "shareId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_shared\_shared\_id Get shared documents. Securely download a shared document. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `sharedId` | string | Yes | — | Shared ID | | `disposition` | string | No | — | Request how the share content will be downloaded: attached as a file or inline. Default is attachment. | | `contentType` | string | No | — | The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav | | `expand` | string | No | — | Expand some document fields | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sharedId": { "type": "string", "description": "Shared ID" }, "disposition": { "type": "string", "description": "Request how the share content will be downloaded: attached as a file or inline. Default is attachment.", "enum": [ "attachment", "inline", "none" ] }, "contentType": { "type": "string", "description": "The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav" }, "expand": { "type": "string", "description": "Expand some document fields", "enum": [ "document.acl" ] } }, "required": [ "PCID", "sharedId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_shares Gets a list of shares. You must specify at least one filter (e.g. entityId). **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `entityId` | string | No | — | Filters the shares returned to only the entity specified by the value of this parameter. | | `expand` | string\[] | No | — | Which fields, if any, to expand. | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entityId": { "type": "string", "description": "Filters the shares returned to only the entity specified by the value of this parameter." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "member" ] }, "description": "Which fields, if any, to expand." }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_status Get a list of statuses for pending operations **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ----------- | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_status\_status\_id Get a status. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `statusId` | string | Yes | — | Status ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "statusId": { "type": "string", "description": "Status ID" } }, "required": [ "PCID", "statusId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_usage Get usage details. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_workspace Get a workspace. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "summary", "acl" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_workspace\_documents Get a list of documents. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `expand` | string\[] | No | — | Which fields, if any, to expand. | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `sortBy` | string | No | — | name or dateCreated | | `sortOrder` | string | No | — | ascending or descending | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "acl", "workspace" ] }, "description": "Which fields, if any, to expand." }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "sortBy": { "type": "string", "description": "name or dateCreated" }, "sortOrder": { "type": "string", "description": "ascending or descending" } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_workspace\_member Get a workspace member **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `memberId` | string | Yes | — | Member ID | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "memberId": { "type": "string", "description": "Member ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "member" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID", "workspaceId", "memberId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_workspace\_members Get a list workspace members **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "member" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_workspace\_tagvalue Get a workspace tag **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `tagId` | string | Yes | — | Tag ID | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "tagId": { "type": "string", "description": "Tag ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "acl" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID", "workspaceId", "tagId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_workspace\_tagvalues Get a list of workspace tags **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `value` | string | No | — | filter the list of tags returned | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "value": { "type": "string", "description": "filter the list of tags returned" }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "acl" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## genesys\_content\_get\_contentmanagement\_workspaces Get a list of workspaces. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | -------------------------------- | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `access` | string\[] | No | — | Requested access level. | | `expand` | string\[] | No | — | Which fields, if any, to expand. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "access": { "type": "array", "items": { "type": "string", "enum": [ "content", "admin", "document:create", "document:viewContent", "document:viewMetadata", "document:download", "document:delete", "document:update", "document:share", "document:shareView", "document:email", "document:print", "document:auditView", "document:replace", "document:tag", "tag:create", "tag:view", "tag:update", "tag:apply", "tag:remove", "tag:delete" ] }, "description": "Requested access level." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "summary", "acl" ] }, "description": "Which fields, if any, to expand." } }, "required": [ "PCID" ] } ``` *** ## genesys\_content\_get\_responsemanagement\_libraries Gets a list of existing response libraries. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `pageNumber` | integer | No | — | Page number | | `pageSize` | integer | No | — | Page size | | `messagingTemplateFilter` | string | No | — | Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel | | `libraryPrefix` | string | No | — | Returns a list of libraries that contain the prefix provided | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageNumber": { "type": "integer", "description": "Page number" }, "pageSize": { "type": "integer", "description": "Page size" }, "messagingTemplateFilter": { "type": "string", "description": "Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel", "enum": [ "whatsapp" ] }, "libraryPrefix": { "type": "string", "description": "Returns a list of libraries that contain the prefix provided" } }, "required": [ "PCID" ] } ``` *** ## genesys\_content\_get\_responsemanagement\_library Get details about an existing response library. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `libraryId` | string | Yes | — | Library ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryId": { "type": "string", "description": "Library ID" } }, "required": [ "PCID", "libraryId" ] } ``` *** ## genesys\_content\_get\_responsemanagement\_response Get details about an existing response. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------------------------------- | | `responseId` | string | Yes | — | Response ID | | `expand` | string | No | — | Expand instructions for the return value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "responseId": { "type": "string", "description": "Response ID" }, "expand": { "type": "string", "description": "Expand instructions for the return value.", "enum": [ "substitutionsSchema" ] } }, "required": [ "PCID", "responseId" ] } ``` *** ## genesys\_content\_get\_responsemanagement\_responseasset Get response asset information **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------- | | `responseAssetId` | string | Yes | — | Asset Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "responseAssetId": { "type": "string", "description": "Asset Id" } }, "required": [ "PCID", "responseAssetId" ] } ``` *** ## genesys\_content\_get\_responsemanagement\_responseassets\_status\_status\_id Get response asset upload status **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `statusId` | string | Yes | — | Status Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "statusId": { "type": "string", "description": "Status Id" } }, "required": [ "PCID", "statusId" ] } ``` *** ## genesys\_content\_get\_responsemanagement\_responses Gets a list of existing responses. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ----------------------------------------- | | `libraryId` | string | Yes | — | Library ID | | `pageNumber` | integer | No | — | Page number | | `pageSize` | integer | No | — | Page size | | `expand` | string | No | — | Expand instructions for the return value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryId": { "type": "string", "description": "Library ID" }, "pageNumber": { "type": "integer", "description": "Page number" }, "pageSize": { "type": "integer", "description": "Page size" }, "expand": { "type": "string", "description": "Expand instructions for the return value.", "enum": [ "substitutionsSchema" ] } }, "required": [ "PCID", "libraryId" ] } ``` *** ## genesys\_content\_post\_contentmanagement\_document Update a document. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------- | | `documentId` | string | Yes | — | Document ID | | `expand` | string | No | — | Expand some document fields | | `override` | boolean | No | — | Override any lock on the document | | `addTagIds` | string\[] | No | — | Add Tag Ids | | `addTags` | string\[] | No | — | Add Tags | | `changeNumber` | integer | No | — | Change Number | | `name` | string | Yes | — | The name of the document | | `read` | boolean | No | — | The read value | | `removeAttributes` | string\[] | No | — | Remove Attributes | | `removeTagIds` | string\[] | No | — | Remove Tag Ids | | `removeTags` | string\[] | No | — | Remove Tags | | `updateAttributes` | object\[] | No | — | Update Attributes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentId": { "type": "string", "description": "Document ID" }, "expand": { "type": "string", "description": "Expand some document fields", "enum": [ "acl" ] }, "override": { "type": "boolean", "description": "Override any lock on the document" }, "addTagIds": { "type": "array", "items": { "type": "string" }, "description": "Add Tag Ids" }, "addTags": { "type": "array", "items": { "type": "string" }, "description": "Add Tags" }, "changeNumber": { "type": "integer", "description": "Change Number" }, "name": { "type": "string", "description": "The name of the document" }, "read": { "type": "boolean", "description": "The read value" }, "removeAttributes": { "type": "array", "items": { "type": "string" }, "description": "Remove Attributes" }, "removeTagIds": { "type": "array", "items": { "type": "string" }, "description": "Remove Tag Ids" }, "removeTags": { "type": "array", "items": { "type": "string" }, "description": "Remove Tags" }, "updateAttributes": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "object", "description": "The attribute value" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The values value" } } }, "description": "Update Attributes" } }, "required": [ "PCID", "documentId", "name" ] } ``` *** ## genesys\_content\_post\_contentmanagement\_document\_content Replace the contents of a document. **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | --------------------------------- | | `documentId` | string | Yes | — | Document ID | | `override` | boolean | No | — | Override any lock on the document | | `authToken` | string | No | — | Auth Token | | `changeNumber` | integer | No | — | Change Number | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentId": { "type": "string", "description": "Document ID" }, "override": { "type": "boolean", "description": "Override any lock on the document" }, "authToken": { "type": "string", "description": "Auth Token" }, "changeNumber": { "type": "integer", "description": "Change Number" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "documentId" ] } ``` *** ## genesys\_content\_post\_contentmanagement\_documents Add a document. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------- | | `copySource` | string | No | — | Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. | | `moveSource` | string | No | — | Move a document to a new workspace. Provide a document ID as the move source. | | `override` | boolean | No | — | Override any lock on the source document | | `name` | string | Yes | — | The name of the document | | `tagIds` | string\[] | No | — | Tag Ids | | `tags` | string\[] | No | — | The tags value | | `workspace` | object | Yes | — | The workspace value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "copySource": { "type": "string", "description": "Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source." }, "moveSource": { "type": "string", "description": "Move a document to a new workspace. Provide a document ID as the move source." }, "override": { "type": "boolean", "description": "Override any lock on the source document" }, "name": { "type": "string", "description": "The name of the document" }, "tagIds": { "type": "array", "items": { "type": "string" }, "description": "Tag Ids" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The tags value" }, "workspace": { "type": "object", "description": "The workspace value", "properties": { "id": { "type": "string", "description": "The id value" }, "name": { "type": "string", "description": "The name value" }, "selfUri": { "type": "string", "description": "Self Uri" } } } }, "required": [ "PCID", "name", "workspace" ] } ``` *** ## genesys\_content\_post\_contentmanagement\_query Query content **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | --------------------------- | | `expand` | string | No | — | Expand some document fields | | `attributeFilters` | object\[] | No | — | Attribute Filters | | `facetNameRequests` | string\[] | No | — | Facet Name Requests | | `filters` | object\[] | No | — | The filters value | | `includeShares` | boolean | No | — | Include Shares | | `pageNumber` | integer | No | — | Page number for pagination | | `pageSize` | integer | No | — | Number of results per page | | `queryPhrase` | string | No | — | Query Phrase | | `sort` | object\[] | No | — | Sort order for results | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "string", "description": "Expand some document fields", "enum": [ "acl", "workspace" ] }, "attributeFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "operator": { "type": "string", "enum": [ "IN", "RANGE", "EQUALS", "NOTEQUALS", "LESSTHAN", "LESSTHANEQUALS", "GREATERTHAN", "GREATERTHANEQUALS", "CONTAINS" ], "description": "The operator value" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The values value" } } }, "description": "Attribute Filters" }, "facetNameRequests": { "type": "array", "items": { "type": "string" }, "description": "Facet Name Requests" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "type": { "type": "string", "enum": [ "NUMBER", "STRING", "DATE", "BOOLEAN", "LIST" ], "description": "The type value" }, "operator": { "type": "string", "enum": [ "IN", "RANGE", "EQUALS", "NOTEQUALS", "LESSTHAN", "LESSTHANEQUALS", "GREATERTHAN", "GREATERTHANEQUALS", "CONTAINS" ], "description": "The operator value" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The values value" } } }, "description": "The filters value" }, "includeShares": { "type": "boolean", "description": "Include Shares" }, "pageNumber": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "queryPhrase": { "type": "string", "description": "Query Phrase" }, "sort": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "ascending": { "type": "boolean", "description": "The ascending value" } } }, "description": "Sort order for results" } }, "required": [ "PCID" ] } ``` *** ## genesys\_content\_post\_contentmanagement\_shares Creates a new share or updates an existing share if the entity has already been shared **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------- | | `member` | object | No | — | The member value | | `members` | object\[] | No | — | The members value | | `memberType` | string | No | — | Member Type | | `sharedEntity` | object | Yes | — | Shared Entity | | `sharedEntityType` | string | Yes | — | The share entity type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "member": { "type": "object", "description": "The member value", "properties": { "id": { "type": "string", "description": "The id value" } } }, "members": { "type": "array", "items": { "type": "object", "properties": { "memberType": { "type": "string", "enum": [ "USER", "GROUP", "PUBLIC" ], "description": "Member Type" }, "member": { "type": "object", "description": "The member value" } } }, "description": "The members value" }, "memberType": { "type": "string", "description": "Member Type", "enum": [ "USER", "GROUP", "PUBLIC" ] }, "sharedEntity": { "type": "object", "description": "Shared Entity", "properties": { "id": { "type": "string", "description": "The id value" } } }, "sharedEntityType": { "type": "string", "description": "The share entity type", "enum": [ "DOCUMENT" ] } }, "required": [ "PCID", "sharedEntity", "sharedEntityType" ] } ``` *** ## genesys\_content\_post\_contentmanagement\_workspace\_tagvalues Create a workspace tag **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ---------------------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `acl` | string\[] | No | — | The acl value | | `id` | string | No | — | The globally unique identifier for the object. | | `inUse` | boolean | No | — | In Use | | `name` | string | Yes | — | The workspace tag name. | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "acl": { "type": "array", "items": { "type": "string" }, "description": "The acl value" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "inUse": { "type": "boolean", "description": "In Use" }, "name": { "type": "string", "description": "The workspace tag name." }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "workspaceId", "name" ] } ``` *** ## genesys\_content\_post\_contentmanagement\_workspace\_tagvalues\_query Perform a prefix query on tags in the workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `expand` | string\[] | No | — | Which fields, if any, to expand. | | `pageNumber` | integer | No | — | Page number for pagination | | `pageSize` | integer | No | — | Number of results per page | | `query` | string | No | — | Search query string | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "acl" ] }, "description": "Which fields, if any, to expand." }, "pageNumber": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "query": { "type": "string", "description": "Search query string" } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## genesys\_content\_post\_contentmanagement\_workspaces Create a group workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------- | | `bucket` | string | No | — | The bucket value | | `description` | string | No | — | The description value | | `name` | string | Yes | — | The workspace name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucket": { "type": "string", "description": "The bucket value" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The workspace name" } }, "required": [ "PCID", "name" ] } ``` *** ## genesys\_content\_post\_responsemanagement\_libraries Create a response library. **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `createdBy` | object | No | — | Created By | | `dateCreated` | string | No | — | The 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 | | `division` | object | No | — | The division value | | `id` | string | No | — | The globally unique identifier for the object. | | `name` | string | Yes | — | The library name. | | `responseType` | string | No | — | This value is deprecated. Responses representing message templates may be added to any library. | | `selfUri` | string | No | — | The URI for this object | | `version` | integer | No | — | Current version for this resource. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "createdBy": { "type": "object", "description": "Created By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "division": { "type": "object", "description": "The division value" }, "chat": { "type": "object", "description": "The chat value" }, "department": { "type": "string", "description": "The department value" }, "email": { "type": "string", "description": "The email value" }, "primaryContactInfo": { "type": "array", "items": { "type": "object" }, "description": "Auto populated from addresses." }, "addresses": { "type": "array", "items": { "type": "object" }, "description": "Email addresses and phone numbers for this user" }, "state": { "type": "string", "description": "The current state for this user.", "enum": [ "active", "inactive", "deleted" ] }, "title": { "type": "string", "description": "The title value" }, "username": { "type": "string", "description": "The username value" }, "manager": { "type": "object", "description": "Circular schema reference: #/components/schemas/User" }, "images": { "type": "array", "items": { "type": "object" }, "description": "The images value" }, "version": { "type": "integer", "description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH." }, "certifications": { "type": "array", "items": { "type": "string" }, "description": "The certifications value" }, "biography": { "type": "object", "description": "The biography value" }, "employerInfo": { "type": "object", "description": "Employer Info" }, "preferredName": { "type": "string", "description": "Preferred full name of the agent" }, "routingStatus": { "type": "object", "description": "Routing Status" }, "presence": { "type": "object", "description": "The presence value" }, "integrationPresence": { "type": "object", "description": "Integration Presence" }, "conversationSummary": { "type": "object", "description": "Conversation Summary" }, "outOfOffice": { "type": "object", "description": "Out Of Office" }, "geolocation": { "type": "object", "description": "The geolocation value" }, "station": { "type": "object", "description": "The station value" }, "authorization": { "type": "object", "description": "The authorization value" }, "profileSkills": { "type": "array", "items": { "type": "string" }, "description": "Profile skills possessed by the user" }, "locations": { "type": "array", "items": { "type": "object" }, "description": "The user placement at each site location." }, "groups": { "type": "array", "items": { "type": "object" }, "description": "The groups the user is a member of" }, "team": { "type": "object", "description": "The team value" }, "workPlanBidRanks": { "type": "object", "description": "Work Plan Bid Ranks" }, "skills": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) skills possessed by the user" }, "languages": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) languages possessed by the user" }, "acdAutoAnswer": { "type": "boolean", "description": "acd auto answer" }, "languagePreference": { "type": "string", "description": "preferred language by the user" }, "lastTokenIssued": { "type": "object", "description": "Last Token Issued" }, "dateLastLogin": { "type": "string", "description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateWelcomeSent": { "type": "string", "description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "version" ] }, "dateCreated": { "type": "string", "description": "The 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" }, "division": { "type": "object", "description": "The division value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The library name." }, "responseType": { "type": "string", "description": "This value is deprecated. Responses representing message templates may be added to any library.", "enum": [ "MessagingTemplate", "CampaignSmsTemplate", "CampaignEmailTemplate", "Footer", "Form", "AppleInvitation" ] }, "selfUri": { "type": "string", "description": "The URI for this object" }, "version": { "type": "integer", "description": "Current version for this resource." } }, "required": [ "PCID", "name" ] } ``` *** ## genesys\_content\_post\_responsemanagement\_libraries\_query Query libraries using criteria. Users can set DivisionId parameter as '\*' to fetch libraries that aren't associated with any divisions. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | --------------------------------------------------- | | `pageNumber` | integer | No | — | Page number | | `pageSize` | integer | No | — | Page size | | `query` | object\[] | Yes | — | List of criteria groups that will be AND'd together | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageNumber": { "type": "integer", "description": "Page number" }, "pageSize": { "type": "integer", "description": "Page size" }, "query": { "type": "array", "items": { "type": "object", "properties": { "and": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key to filter on" }, "operator": { "type": "string", "description": "The operator for comparison. For DivisionId, only EQUALS and NOTEQUALS operators are supported." }, "value": { "type": "string", "description": "The target value to match" } } }, "description": "Items that will be AND'd together" }, "or": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key to filter on" }, "operator": { "type": "string", "description": "The operator for comparison. For DivisionId, only EQUALS and NOTEQUALS operators are supported." }, "value": { "type": "string", "description": "The target value to match" } } }, "description": "Items that will be OR'd together" }, "not": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key to filter on" }, "operator": { "type": "string", "description": "The operator for comparison. For DivisionId, only EQUALS and NOTEQUALS operators are supported." }, "value": { "type": "string", "description": "The target value to match" } } }, "description": "Items that must all be false" }, "criteria": { "type": "object", "description": "A singular item used to query libraries" } } }, "description": "List of criteria groups that will be AND'd together" } }, "required": [ "PCID", "query" ] } ``` *** ## genesys\_content\_post\_responsemanagement\_responseassets\_search Search response assets **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | -------------------------------------------------------------- | | `expand` | string\[] | No | — | Which fields, if any, to expand | | `pageNumber` | integer | No | — | The page of resources you want to retrieve | | `pageSize` | integer | No | — | The number of results per page. Default: 25, Maximum: 100. | | `query` | object\[] | Yes | — | Filter the query results. | | `sortBy` | string | No | — | The field in the resource that you want to sort the results by | | `sortOrder` | string | No | — | The sort order for results | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "user", "division" ] }, "description": "Which fields, if any, to expand" }, "pageNumber": { "type": "integer", "description": "The page of resources you want to retrieve" }, "pageSize": { "type": "integer", "description": "The number of results per page. Default: 25, Maximum: 100." }, "query": { "type": "array", "items": { "type": "object", "properties": { "endValue": { "type": "string", "description": "The end value of the range. This field is used for range search types. Accepts numbers and date in ISO8601 format" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of values for the search to match against" }, "startValue": { "type": "string", "description": "The start value of the range. This field is used for range search types. Accepts numbers and date in ISO8601 format" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Field name to search against. Allowed Values: divisionId, name, contentLength, contentType, dateCreated" }, "value": { "type": "string", "description": "A value for the search to match against" }, "type": { "type": "string", "enum": [ "TERM", "TERMS", "STARTS_WITH", "RANGE", "GREATER_THAN_EQUAL_TO", "LESS_THAN_EQUAL_TO", "DATE_RANGE" ], "description": "How to apply this search criteria against other criteria. Filter type supported for each field:- name:[STARTS_WITH, TERM], divisionId:[TERM, TERMS], contentLength:[RANGE, GREATER_THAN_EQUAL_TO, LESS_THAN_EQUAL_TO], contentType:[STARTS_WITH, TERM] dateCreated:[DATE_RANGE]" } } }, "description": "Filter the query results." }, "sortBy": { "type": "string", "description": "The field in the resource that you want to sort the results by" }, "sortOrder": { "type": "string", "description": "The sort order for results", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID", "query" ] } ``` *** ## genesys\_content\_post\_responsemanagement\_responseassets\_uploads Creates pre-signed url for uploading response asset **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentMd5` | string | No | — | Content MD-5 of the file to upload | | `divisionId` | string | No | — | Division to associate to this asset. Can only be used with this division. | | `name` | string | Yes | — | Name 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: \{^}%\`]">\[\~\<#\| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contentMd5": { "type": "string", "description": "Content MD-5 of the file to upload" }, "divisionId": { "type": "string", "description": "Division to associate to this asset. Can only be used with this division." }, "name": { "type": "string", "description": "Name 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: \\{^}%`]\">[~<#|" } }, "required": [ "PCID", "name" ] } ``` *** ## genesys\_content\_post\_responsemanagement\_responses Create a response. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `expand` | string | No | — | Expand instructions for the return value. | | `appleInvitation` | object | No | — | Apple Messages for Business invitation template configuration | | `assets` | object\[] | No | — | Assets used in the response | | `createdBy` | object | No | — | Created By | | `dateCreated` | string | No | — | The 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 | | `footer` | object | No | — | The Footer template identifies the Footer type and its footerUsage | | `id` | string | No | — | The globally unique identifier for the object. | | `interactionType` | string | No | — | The interaction type for this response. | | `libraries` | object\[] | Yes | — | One or more libraries response is associated with. | | `messagingTemplate` | object | No | — | The messaging template identifies a structured message templates supported by a messaging channel. | | `name` | string | No | — | The name value | | `responseType` | string | No | — | The response type represented by the response. | | `selfUri` | string | No | — | The URI for this object | | `substitutions` | object\[] | No | — | Details about any text substitutions used in the texts for this response. | | `substitutionsSchema` | object | No | — | A JSON Schema document. | | `texts` | object\[] | No | — | One or more texts associated with the response. Required for responseTypes: Standard, Footer, MessagingTemplate and CampaignEmailTemplate | | `version` | integer | No | — | Version number required for updates. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "string", "description": "Expand instructions for the return value.", "enum": [ "substitutionsSchema" ] }, "appleInvitation": { "type": "object", "description": "Apple Messages for Business invitation template configuration", "properties": { "businessName": { "type": "string", "description": "The business name displayed in the invitation" }, "transcriptMessage": { "type": "string", "description": "The transcript message displayed in the invitation" }, "templateType": { "type": "string", "description": "The template type for the invitation", "enum": [ "WithImage", "WithoutImage" ] }, "locale": { "type": "string", "description": "The locale for the invitation" } }, "required": [ "businessName", "locale", "templateType", "transcriptMessage" ] }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "selfUri": { "type": "string", "format": "uri", "description": "Self Uri" }, "assetUsage": { "type": "string", "enum": [ "FileAttachments" ], "description": "Usage of the asset. Null for inline images, 'FileAttachments' for file attachments" }, "contentLocation": { "type": "string", "description": "Content location URL for the asset" } } }, "description": "Assets used in the response" }, "createdBy": { "type": "object", "description": "Created By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "division": { "type": "object", "description": "The division value" }, "chat": { "type": "object", "description": "The chat value" }, "department": { "type": "string", "description": "The department value" }, "email": { "type": "string", "description": "The email value" }, "primaryContactInfo": { "type": "array", "items": { "type": "object" }, "description": "Auto populated from addresses." }, "addresses": { "type": "array", "items": { "type": "object" }, "description": "Email addresses and phone numbers for this user" }, "state": { "type": "string", "description": "The current state for this user.", "enum": [ "active", "inactive", "deleted" ] }, "title": { "type": "string", "description": "The title value" }, "username": { "type": "string", "description": "The username value" }, "manager": { "type": "object", "description": "Circular schema reference: #/components/schemas/User" }, "images": { "type": "array", "items": { "type": "object" }, "description": "The images value" }, "version": { "type": "integer", "description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH." }, "certifications": { "type": "array", "items": { "type": "string" }, "description": "The certifications value" }, "biography": { "type": "object", "description": "The biography value" }, "employerInfo": { "type": "object", "description": "Employer Info" }, "preferredName": { "type": "string", "description": "Preferred full name of the agent" }, "routingStatus": { "type": "object", "description": "Routing Status" }, "presence": { "type": "object", "description": "The presence value" }, "integrationPresence": { "type": "object", "description": "Integration Presence" }, "conversationSummary": { "type": "object", "description": "Conversation Summary" }, "outOfOffice": { "type": "object", "description": "Out Of Office" }, "geolocation": { "type": "object", "description": "The geolocation value" }, "station": { "type": "object", "description": "The station value" }, "authorization": { "type": "object", "description": "The authorization value" }, "profileSkills": { "type": "array", "items": { "type": "string" }, "description": "Profile skills possessed by the user" }, "locations": { "type": "array", "items": { "type": "object" }, "description": "The user placement at each site location." }, "groups": { "type": "array", "items": { "type": "object" }, "description": "The groups the user is a member of" }, "team": { "type": "object", "description": "The team value" }, "workPlanBidRanks": { "type": "object", "description": "Work Plan Bid Ranks" }, "skills": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) skills possessed by the user" }, "languages": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) languages possessed by the user" }, "acdAutoAnswer": { "type": "boolean", "description": "acd auto answer" }, "languagePreference": { "type": "string", "description": "preferred language by the user" }, "lastTokenIssued": { "type": "object", "description": "Last Token Issued" }, "dateLastLogin": { "type": "string", "description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateWelcomeSent": { "type": "string", "description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "version" ] }, "dateCreated": { "type": "string", "description": "The 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" }, "footer": { "type": "object", "description": "The Footer template identifies the Footer type and its footerUsage", "properties": { "type": { "type": "string", "description": "Specifies the type represented by Footer.", "enum": [ "Signature" ] }, "applicableResources": { "type": "array", "items": { "type": "string", "enum": [ "Campaign" ] }, "description": "Specifies the canned response template where the footer can be used." } } }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "interactionType": { "type": "string", "description": "The interaction type for this response.", "enum": [ "chat", "email", "twitter" ] }, "libraries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "name": { "type": "string", "description": "The name value" }, "selfUri": { "type": "string", "format": "uri", "description": "Self Uri" } } }, "description": "One or more libraries response is associated with." }, "messagingTemplate": { "type": "object", "description": "The messaging template identifies a structured message templates supported by a messaging channel.", "properties": { "whatsApp": { "type": "object", "description": "A WhatsApp messaging template definition as defined in the WhatsApp Business Manager" } } }, "name": { "type": "string", "description": "The name value" }, "responseType": { "type": "string", "description": "The response type represented by the response.", "enum": [ "MessagingTemplate", "CampaignSmsTemplate", "CampaignEmailTemplate", "Footer", "Form", "AppleInvitation" ] }, "selfUri": { "type": "string", "description": "The URI for this object" }, "substitutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Response substitution identifier." }, "description": { "type": "string", "description": "Response substitution description." }, "defaultValue": { "type": "string", "description": "Response substitution default value." } }, "required": [ "id" ] }, "description": "Details about any text substitutions used in the texts for this response." }, "substitutionsSchema": { "type": "object", "description": "A JSON Schema document.", "properties": { "id": { "type": "string", "description": "The id value" }, "$schema": { "type": "string", "description": "The $schema value" }, "title": { "type": "string", "description": "The title value" }, "description": { "type": "string", "description": "The description value" }, "type": { "type": "string", "description": "The type value" }, "required": { "type": "array", "items": { "type": "string" }, "description": "The required value" }, "properties": { "type": "object", "description": "The properties value" }, "additionalProperties": { "type": "object", "description": "Additional Properties" } } }, "texts": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "description": "Response text content." }, "contentType": { "type": "string", "enum": [ "text/plain", "text/html" ], "description": "Response text content type." }, "type": { "type": "string", "enum": [ "body", "subject" ], "description": "Response text type." } }, "required": [ "content" ] }, "description": "One or more texts associated with the response. Required for responseTypes: Standard, Footer, MessagingTemplate and CampaignEmailTemplate" }, "version": { "type": "integer", "description": "Version number required for updates." } }, "required": [ "PCID", "libraries" ] } ``` *** ## genesys\_content\_post\_responsemanagement\_responses\_query Query responses **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ------------------------------------------------------------------------- | | `filters` | object\[] | No | — | Filter the query results. | | `pageNumber` | integer | No | — | Page Number | | `pageSize` | integer | No | — | The maximum number of hits to return. Default: 25, Maximum: 500. | | `queryPhrase` | string | No | — | Query phrase to search response text and name. If not set will match all. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Field to filter on. Allowed values are 'name', 'libraryId', 'text.contentType', 'messagingTemplate' and 'responseType'" }, "operator": { "type": "string", "enum": [ "IN", "EQUALS", "NOTEQUALS", "BEGINS_WITH", "ENDS_WITH", "CONTAINS" ], "description": "Filter operation: IN, EQUALS, NOTEQUALS." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values to filter on. If name is 'responseType' then allowed values are 'CampaignSmsTemplate', 'CampaignEmailTemplate', 'Footer' and 'Signature'" } }, "required": [ "name", "operator", "values" ] }, "description": "Filter the query results." }, "pageNumber": { "type": "integer", "description": "Page Number" }, "pageSize": { "type": "integer", "description": "The maximum number of hits to return. Default: 25, Maximum: 500." }, "queryPhrase": { "type": "string", "description": "Query phrase to search response text and name. If not set will match all." } }, "required": [ "PCID" ] } ``` *** ## genesys\_content\_put\_contentmanagement\_workspace Update a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `acl` | string\[] | No | — | The acl value | | `bucket` | string | No | — | The bucket value | | `dateCreated` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dateModified` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `description` | string | No | — | The description value | | `id` | string | No | — | The globally unique identifier for the object. | | `isCurrentUserWorkspace` | boolean | No | — | Is Current User Workspace | | `name` | string | Yes | — | The current name of the workspace. | | `selfUri` | string | No | — | The URI for this object | | `summary` | object | No | — | The summary value | | `type` | string | No | — | The type value | | `user` | object | No | — | The user value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "acl": { "type": "array", "items": { "type": "string" }, "description": "The acl value" }, "bucket": { "type": "string", "description": "The bucket value" }, "dateCreated": { "type": "string", "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateModified": { "type": "string", "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "description": { "type": "string", "description": "The description value" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "isCurrentUserWorkspace": { "type": "boolean", "description": "Is Current User Workspace" }, "name": { "type": "string", "description": "The current name of the workspace." }, "selfUri": { "type": "string", "description": "The URI for this object" }, "summary": { "type": "object", "description": "The summary value", "properties": { "totalDocumentCount": { "type": "integer", "description": "Total Document Count" }, "totalDocumentByteCount": { "type": "integer", "description": "Total Document Byte Count" } } }, "type": { "type": "string", "description": "The type value", "enum": [ "USER", "GROUP" ] }, "user": { "type": "object", "description": "The user value", "properties": { "id": { "type": "string", "description": "The id value" }, "name": { "type": "string", "description": "The name value" }, "selfUri": { "type": "string", "description": "Self Uri" } } } }, "required": [ "PCID", "workspaceId", "name" ] } ``` *** ## genesys\_content\_put\_contentmanagement\_workspace\_member Add a member to a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `memberId` | string | Yes | — | Member ID | | `group` | object | No | — | The group value | | `id` | string | No | — | The globally unique identifier for the object. | | `member` | object | No | — | The member value | | `memberType` | string | Yes | — | The workspace member type. | | `name` | string | No | — | The name value | | `securityProfile` | object | No | — | Security Profile | | `selfUri` | string | No | — | The URI for this object | | `user` | object | No | — | The user value | | `workspace` | object | No | — | The workspace value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "memberId": { "type": "string", "description": "Member ID" }, "group": { "type": "object", "description": "The group value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The group name." }, "description": { "type": "string", "description": "The description value" }, "dateModified": { "type": "string", "description": "Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "memberCount": { "type": "integer", "description": "Number of members." }, "state": { "type": "string", "description": "Active, inactive, or deleted state.", "enum": [ "active", "inactive", "deleted" ] }, "version": { "type": "integer", "description": "Current version for this resource." }, "type": { "type": "string", "description": "Type of group.", "enum": [ "official", "social" ] }, "images": { "type": "array", "items": { "type": "object" }, "description": "The images value" }, "addresses": { "type": "array", "items": { "type": "object" }, "description": "The addresses value" }, "rulesVisible": { "type": "boolean", "description": "Are membership rules visible to the person requesting to view the group" }, "visibility": { "type": "string", "description": "Who can view this group", "enum": [ "public", "owners", "members" ] }, "rolesEnabled": { "type": "boolean", "description": "Allow roles to be assigned to this group" }, "includeOwners": { "type": "boolean", "description": "Allow owners to be included as members of the group" }, "callsEnabled": { "type": "boolean", "description": "Allow calls to be placed to this group." }, "owners": { "type": "array", "items": { "type": "object" }, "description": "Owners of the group" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "name", "rulesVisible", "type", "visibility" ] }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "member": { "type": "object", "description": "The member value", "properties": { "id": { "type": "string", "description": "The id value" }, "name": { "type": "string", "description": "The name value" }, "selfUri": { "type": "string", "description": "Self Uri" } } }, "memberType": { "type": "string", "description": "The workspace member type.", "enum": [ "USER", "GROUP" ] }, "name": { "type": "string", "description": "The name value" }, "securityProfile": { "type": "object", "description": "Security Profile", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions value" }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "selfUri": { "type": "string", "description": "The URI for this object" }, "user": { "type": "object", "description": "The user value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "division": { "type": "object", "description": "The division value" }, "chat": { "type": "object", "description": "The chat value" }, "department": { "type": "string", "description": "The department value" }, "email": { "type": "string", "description": "The email value" }, "primaryContactInfo": { "type": "array", "items": { "type": "object" }, "description": "Auto populated from addresses." }, "addresses": { "type": "array", "items": { "type": "object" }, "description": "Email addresses and phone numbers for this user" }, "state": { "type": "string", "description": "The current state for this user.", "enum": [ "active", "inactive", "deleted" ] }, "title": { "type": "string", "description": "The title value" }, "username": { "type": "string", "description": "The username value" }, "manager": { "type": "object", "description": "Circular schema reference: #/components/schemas/User" }, "images": { "type": "array", "items": { "type": "object" }, "description": "The images value" }, "version": { "type": "integer", "description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH." }, "certifications": { "type": "array", "items": { "type": "string" }, "description": "The certifications value" }, "biography": { "type": "object", "description": "The biography value" }, "employerInfo": { "type": "object", "description": "Employer Info" }, "preferredName": { "type": "string", "description": "Preferred full name of the agent" }, "routingStatus": { "type": "object", "description": "Routing Status" }, "presence": { "type": "object", "description": "The presence value" }, "integrationPresence": { "type": "object", "description": "Integration Presence" }, "conversationSummary": { "type": "object", "description": "Conversation Summary" }, "outOfOffice": { "type": "object", "description": "Out Of Office" }, "geolocation": { "type": "object", "description": "The geolocation value" }, "station": { "type": "object", "description": "The station value" }, "authorization": { "type": "object", "description": "The authorization value" }, "profileSkills": { "type": "array", "items": { "type": "string" }, "description": "Profile skills possessed by the user" }, "locations": { "type": "array", "items": { "type": "object" }, "description": "The user placement at each site location." }, "groups": { "type": "array", "items": { "type": "object" }, "description": "The groups the user is a member of" }, "team": { "type": "object", "description": "The team value" }, "workPlanBidRanks": { "type": "object", "description": "Work Plan Bid Ranks" }, "skills": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) skills possessed by the user" }, "languages": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) languages possessed by the user" }, "acdAutoAnswer": { "type": "boolean", "description": "acd auto answer" }, "languagePreference": { "type": "string", "description": "preferred language by the user" }, "lastTokenIssued": { "type": "object", "description": "Last Token Issued" }, "dateLastLogin": { "type": "string", "description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateWelcomeSent": { "type": "string", "description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "version" ] }, "workspace": { "type": "object", "description": "The workspace value", "properties": { "id": { "type": "string", "description": "The id value" }, "name": { "type": "string", "description": "The name value" }, "selfUri": { "type": "string", "description": "Self Uri" } } } }, "required": [ "PCID", "workspaceId", "memberId", "memberType" ] } ``` *** ## genesys\_content\_put\_contentmanagement\_workspace\_tagvalue Update a workspace tag. Will update all documents with the new tag value. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ---------------------------------------------- | | `workspaceId` | string | Yes | — | Workspace ID | | `tagId` | string | Yes | — | Tag ID | | `acl` | string\[] | No | — | The acl value | | `id` | string | No | — | The globally unique identifier for the object. | | `inUse` | boolean | No | — | In Use | | `name` | string | Yes | — | The workspace tag name. | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace ID" }, "tagId": { "type": "string", "description": "Tag ID" }, "acl": { "type": "array", "items": { "type": "string" }, "description": "The acl value" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "inUse": { "type": "boolean", "description": "In Use" }, "name": { "type": "string", "description": "The workspace tag name." }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "workspaceId", "tagId", "name" ] } ``` *** ## genesys\_content\_put\_responsemanagement\_library Update an existing response library. **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `libraryId` | string | Yes | — | Library ID | | `createdBy` | object | No | — | Created By | | `dateCreated` | string | No | — | The 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 | | `division` | object | No | — | The division value | | `id` | string | No | — | The globally unique identifier for the object. | | `name` | string | Yes | — | The library name. | | `responseType` | string | No | — | This value is deprecated. Responses representing message templates may be added to any library. | | `selfUri` | string | No | — | The URI for this object | | `version` | integer | No | — | Current version for this resource. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryId": { "type": "string", "description": "Library ID" }, "createdBy": { "type": "object", "description": "Created By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "division": { "type": "object", "description": "The division value" }, "chat": { "type": "object", "description": "The chat value" }, "department": { "type": "string", "description": "The department value" }, "email": { "type": "string", "description": "The email value" }, "primaryContactInfo": { "type": "array", "items": { "type": "object" }, "description": "Auto populated from addresses." }, "addresses": { "type": "array", "items": { "type": "object" }, "description": "Email addresses and phone numbers for this user" }, "state": { "type": "string", "description": "The current state for this user.", "enum": [ "active", "inactive", "deleted" ] }, "title": { "type": "string", "description": "The title value" }, "username": { "type": "string", "description": "The username value" }, "manager": { "type": "object", "description": "Circular schema reference: #/components/schemas/User" }, "images": { "type": "array", "items": { "type": "object" }, "description": "The images value" }, "version": { "type": "integer", "description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH." }, "certifications": { "type": "array", "items": { "type": "string" }, "description": "The certifications value" }, "biography": { "type": "object", "description": "The biography value" }, "employerInfo": { "type": "object", "description": "Employer Info" }, "preferredName": { "type": "string", "description": "Preferred full name of the agent" }, "routingStatus": { "type": "object", "description": "Routing Status" }, "presence": { "type": "object", "description": "The presence value" }, "integrationPresence": { "type": "object", "description": "Integration Presence" }, "conversationSummary": { "type": "object", "description": "Conversation Summary" }, "outOfOffice": { "type": "object", "description": "Out Of Office" }, "geolocation": { "type": "object", "description": "The geolocation value" }, "station": { "type": "object", "description": "The station value" }, "authorization": { "type": "object", "description": "The authorization value" }, "profileSkills": { "type": "array", "items": { "type": "string" }, "description": "Profile skills possessed by the user" }, "locations": { "type": "array", "items": { "type": "object" }, "description": "The user placement at each site location." }, "groups": { "type": "array", "items": { "type": "object" }, "description": "The groups the user is a member of" }, "team": { "type": "object", "description": "The team value" }, "workPlanBidRanks": { "type": "object", "description": "Work Plan Bid Ranks" }, "skills": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) skills possessed by the user" }, "languages": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) languages possessed by the user" }, "acdAutoAnswer": { "type": "boolean", "description": "acd auto answer" }, "languagePreference": { "type": "string", "description": "preferred language by the user" }, "lastTokenIssued": { "type": "object", "description": "Last Token Issued" }, "dateLastLogin": { "type": "string", "description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateWelcomeSent": { "type": "string", "description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "version" ] }, "dateCreated": { "type": "string", "description": "The 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" }, "division": { "type": "object", "description": "The division value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The library name." }, "responseType": { "type": "string", "description": "This value is deprecated. Responses representing message templates may be added to any library.", "enum": [ "MessagingTemplate", "CampaignSmsTemplate", "CampaignEmailTemplate", "Footer", "Form", "AppleInvitation" ] }, "selfUri": { "type": "string", "description": "The URI for this object" }, "version": { "type": "integer", "description": "Current version for this resource." } }, "required": [ "PCID", "libraryId", "name" ] } ``` *** ## genesys\_content\_put\_responsemanagement\_response Update an existing response. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `responseId` | string | Yes | — | Response ID | | `expand` | string | No | — | Expand instructions for the return value. | | `appleInvitation` | object | No | — | Apple Messages for Business invitation template configuration | | `assets` | object\[] | No | — | Assets used in the response | | `createdBy` | object | No | — | Created By | | `dateCreated` | string | No | — | The 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 | | `footer` | object | No | — | The Footer template identifies the Footer type and its footerUsage | | `id` | string | No | — | The globally unique identifier for the object. | | `interactionType` | string | No | — | The interaction type for this response. | | `libraries` | object\[] | Yes | — | One or more libraries response is associated with. | | `messagingTemplate` | object | No | — | The messaging template identifies a structured message templates supported by a messaging channel. | | `name` | string | No | — | The name value | | `responseType` | string | No | — | The response type represented by the response. | | `selfUri` | string | No | — | The URI for this object | | `substitutions` | object\[] | No | — | Details about any text substitutions used in the texts for this response. | | `substitutionsSchema` | object | No | — | A JSON Schema document. | | `texts` | object\[] | No | — | One or more texts associated with the response. Required for responseTypes: Standard, Footer, MessagingTemplate and CampaignEmailTemplate | | `version` | integer | No | — | Version number required for updates. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "responseId": { "type": "string", "description": "Response ID" }, "expand": { "type": "string", "description": "Expand instructions for the return value.", "enum": [ "substitutionsSchema" ] }, "appleInvitation": { "type": "object", "description": "Apple Messages for Business invitation template configuration", "properties": { "businessName": { "type": "string", "description": "The business name displayed in the invitation" }, "transcriptMessage": { "type": "string", "description": "The transcript message displayed in the invitation" }, "templateType": { "type": "string", "description": "The template type for the invitation", "enum": [ "WithImage", "WithoutImage" ] }, "locale": { "type": "string", "description": "The locale for the invitation" } }, "required": [ "businessName", "locale", "templateType", "transcriptMessage" ] }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "selfUri": { "type": "string", "format": "uri", "description": "Self Uri" }, "assetUsage": { "type": "string", "enum": [ "FileAttachments" ], "description": "Usage of the asset. Null for inline images, 'FileAttachments' for file attachments" }, "contentLocation": { "type": "string", "description": "Content location URL for the asset" } } }, "description": "Assets used in the response" }, "createdBy": { "type": "object", "description": "Created By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "division": { "type": "object", "description": "The division value" }, "chat": { "type": "object", "description": "The chat value" }, "department": { "type": "string", "description": "The department value" }, "email": { "type": "string", "description": "The email value" }, "primaryContactInfo": { "type": "array", "items": { "type": "object" }, "description": "Auto populated from addresses." }, "addresses": { "type": "array", "items": { "type": "object" }, "description": "Email addresses and phone numbers for this user" }, "state": { "type": "string", "description": "The current state for this user.", "enum": [ "active", "inactive", "deleted" ] }, "title": { "type": "string", "description": "The title value" }, "username": { "type": "string", "description": "The username value" }, "manager": { "type": "object", "description": "Circular schema reference: #/components/schemas/User" }, "images": { "type": "array", "items": { "type": "object" }, "description": "The images value" }, "version": { "type": "integer", "description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH." }, "certifications": { "type": "array", "items": { "type": "string" }, "description": "The certifications value" }, "biography": { "type": "object", "description": "The biography value" }, "employerInfo": { "type": "object", "description": "Employer Info" }, "preferredName": { "type": "string", "description": "Preferred full name of the agent" }, "routingStatus": { "type": "object", "description": "Routing Status" }, "presence": { "type": "object", "description": "The presence value" }, "integrationPresence": { "type": "object", "description": "Integration Presence" }, "conversationSummary": { "type": "object", "description": "Conversation Summary" }, "outOfOffice": { "type": "object", "description": "Out Of Office" }, "geolocation": { "type": "object", "description": "The geolocation value" }, "station": { "type": "object", "description": "The station value" }, "authorization": { "type": "object", "description": "The authorization value" }, "profileSkills": { "type": "array", "items": { "type": "string" }, "description": "Profile skills possessed by the user" }, "locations": { "type": "array", "items": { "type": "object" }, "description": "The user placement at each site location." }, "groups": { "type": "array", "items": { "type": "object" }, "description": "The groups the user is a member of" }, "team": { "type": "object", "description": "The team value" }, "workPlanBidRanks": { "type": "object", "description": "Work Plan Bid Ranks" }, "skills": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) skills possessed by the user" }, "languages": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) languages possessed by the user" }, "acdAutoAnswer": { "type": "boolean", "description": "acd auto answer" }, "languagePreference": { "type": "string", "description": "preferred language by the user" }, "lastTokenIssued": { "type": "object", "description": "Last Token Issued" }, "dateLastLogin": { "type": "string", "description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateWelcomeSent": { "type": "string", "description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "version" ] }, "dateCreated": { "type": "string", "description": "The 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" }, "footer": { "type": "object", "description": "The Footer template identifies the Footer type and its footerUsage", "properties": { "type": { "type": "string", "description": "Specifies the type represented by Footer.", "enum": [ "Signature" ] }, "applicableResources": { "type": "array", "items": { "type": "string", "enum": [ "Campaign" ] }, "description": "Specifies the canned response template where the footer can be used." } } }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "interactionType": { "type": "string", "description": "The interaction type for this response.", "enum": [ "chat", "email", "twitter" ] }, "libraries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "name": { "type": "string", "description": "The name value" }, "selfUri": { "type": "string", "format": "uri", "description": "Self Uri" } } }, "description": "One or more libraries response is associated with." }, "messagingTemplate": { "type": "object", "description": "The messaging template identifies a structured message templates supported by a messaging channel.", "properties": { "whatsApp": { "type": "object", "description": "A WhatsApp messaging template definition as defined in the WhatsApp Business Manager" } } }, "name": { "type": "string", "description": "The name value" }, "responseType": { "type": "string", "description": "The response type represented by the response.", "enum": [ "MessagingTemplate", "CampaignSmsTemplate", "CampaignEmailTemplate", "Footer", "Form", "AppleInvitation" ] }, "selfUri": { "type": "string", "description": "The URI for this object" }, "substitutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Response substitution identifier." }, "description": { "type": "string", "description": "Response substitution description." }, "defaultValue": { "type": "string", "description": "Response substitution default value." } }, "required": [ "id" ] }, "description": "Details about any text substitutions used in the texts for this response." }, "substitutionsSchema": { "type": "object", "description": "A JSON Schema document.", "properties": { "id": { "type": "string", "description": "The id value" }, "$schema": { "type": "string", "description": "The $schema value" }, "title": { "type": "string", "description": "The title value" }, "description": { "type": "string", "description": "The description value" }, "type": { "type": "string", "description": "The type value" }, "required": { "type": "array", "items": { "type": "string" }, "description": "The required value" }, "properties": { "type": "object", "description": "The properties value" }, "additionalProperties": { "type": "object", "description": "Additional Properties" } } }, "texts": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "description": "Response text content." }, "contentType": { "type": "string", "enum": [ "text/plain", "text/html" ], "description": "Response text content type." }, "type": { "type": "string", "enum": [ "body", "subject" ], "description": "Response text type." } }, "required": [ "content" ] }, "description": "One or more texts associated with the response. Required for responseTypes: Standard, Footer, MessagingTemplate and CampaignEmailTemplate" }, "version": { "type": "integer", "description": "Version number required for updates." } }, "required": [ "PCID", "responseId", "libraries" ] } ``` *** ## genesys\_content\_put\_responsemanagement\_responseasset Update response asset **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `responseAssetId` | string | Yes | — | Asset Id | | `divisionId` | string | No | — | Division to associate to this asset. Can only be used with this division. | | `name` | string | Yes | — | Name 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: \{^}%\`]">\[\~\<#\| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "responseAssetId": { "type": "string", "description": "Asset Id" }, "divisionId": { "type": "string", "description": "Division to associate to this asset. Can only be used with this division." }, "name": { "type": "string", "description": "Name 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: \\{^}%`]\">[~<#|" } }, "required": [ "PCID", "responseAssetId", "name" ] } ```