/genesys-chat | Type: Application | PCID required: Yes
Tools
genesys_chat_delete_chats_room_message
Delete a message in a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomId |
messageId | string | Yes | — | Message Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "roomId"
},
"messageId": {
"type": "string",
"description": "Message Id"
}
},
"required": [
"PCID",
"roomJid",
"messageId"
]
}
genesys_chat_delete_chats_room_messages_pin
Remove a pinned message from a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
pinnedMessageId | string | Yes | — | Pinned Message Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"pinnedMessageId": {
"type": "string",
"description": "Pinned Message Id"
}
},
"required": [
"PCID",
"roomJid",
"pinnedMessageId"
]
}
genesys_chat_delete_chats_room_participant
Remove a user from a room. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
userId | string | Yes | — | User Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"userId": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"roomJid",
"userId"
]
}
genesys_chat_delete_chats_user_message
Delete a message to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
messageId | string | Yes | — | Message Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"messageId": {
"type": "string",
"description": "Message Id"
}
},
"required": [
"PCID",
"userId",
"messageId"
]
}
genesys_chat_delete_chats_user_messages_pin
Remove a pinned message from a 1on1 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
pinnedMessageId | string | Yes | — | Pinned Message Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"pinnedMessageId": {
"type": "string",
"description": "Pinned Message Id"
}
},
"required": [
"PCID",
"userId",
"pinnedMessageId"
]
}
genesys_chat_delete_chats_users_me_settings
Delete a user’s chat settingsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_chat_get_chats_message
Get a message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "Message Id"
}
},
"required": [
"PCID",
"messageId"
]
}
genesys_chat_get_chats_room
Get a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
}
},
"required": [
"PCID",
"roomJid"
]
}
genesys_chat_get_chats_room_message
Get messages by id(s) from a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
messageIds | string | Yes | — | messageIds, comma separated |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"messageIds": {
"type": "string",
"description": "messageIds, comma separated"
}
},
"required": [
"PCID",
"roomJid",
"messageIds"
]
}
genesys_chat_get_chats_room_messages
Get a room’s message history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
limit | string | No | — | The maximum number of messages to retrieve |
before | string | No | — | The cutoff date for messages to retrieve |
after | string | No | — | The beginning date for messages to retrieve |
excludeMetadata | boolean | No | — | Whether to exclude metadata for messages |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"limit": {
"type": "string",
"description": "The maximum number of messages to retrieve"
},
"before": {
"type": "string",
"description": "The cutoff date for messages to retrieve"
},
"after": {
"type": "string",
"description": "The beginning date for messages to retrieve"
},
"excludeMetadata": {
"type": "boolean",
"description": "Whether to exclude metadata for messages"
}
},
"required": [
"PCID",
"roomJid"
]
}
genesys_chat_get_chats_room_participant
Get a room participant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
participantJid | string | Yes | — | Participant Jid |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"participantJid": {
"type": "string",
"description": "Participant Jid"
}
},
"required": [
"PCID",
"roomJid",
"participantJid"
]
}
genesys_chat_get_chats_room_participants
Get room participants in a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
notify | boolean | No | — | Whether to get users to notify |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"notify": {
"type": "boolean",
"description": "Whether to get users to notify"
}
},
"required": [
"PCID",
"roomJid"
]
}
genesys_chat_get_chats_settings
Get Chat Settings.Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_chat_get_chats_thread_messages
Get history by thread Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
threadId | string | Yes | — | Thread Id |
limit | string | No | — | The maximum number of messages to retrieve |
before | string | No | — | The cutoff date for messages to retrieve |
after | string | No | — | The beginning date for messages to retrieve |
excludeMetadata | boolean | No | — | Whether to exclude metadata for messages |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"threadId": {
"type": "string",
"description": "Thread Id"
},
"limit": {
"type": "string",
"description": "The maximum number of messages to retrieve"
},
"before": {
"type": "string",
"description": "The cutoff date for messages to retrieve"
},
"after": {
"type": "string",
"description": "The beginning date for messages to retrieve"
},
"excludeMetadata": {
"type": "boolean",
"description": "Whether to exclude metadata for messages"
}
},
"required": [
"PCID",
"threadId"
]
}
genesys_chat_get_chats_user
Get information for a 1on1 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"userId"
]
}
genesys_chat_get_chats_user_message
Get messages by id(s) from a 1on1 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
messageIds | string | Yes | — | messageIds, comma separated |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"messageIds": {
"type": "string",
"description": "messageIds, comma separated"
}
},
"required": [
"PCID",
"userId",
"messageIds"
]
}
genesys_chat_get_chats_user_messages
Get 1on1 History between a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
limit | string | No | — | The maximum number of messages to retrieve |
before | string | No | — | The cutoff date for messages to retrieve |
after | string | No | — | The beginning date for messages to retrieve |
excludeMetadata | boolean | No | — | Whether to exclude metadata for messages |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"limit": {
"type": "string",
"description": "The maximum number of messages to retrieve"
},
"before": {
"type": "string",
"description": "The cutoff date for messages to retrieve"
},
"after": {
"type": "string",
"description": "The beginning date for messages to retrieve"
},
"excludeMetadata": {
"type": "boolean",
"description": "Whether to exclude metadata for messages"
}
},
"required": [
"PCID",
"userId"
]
}
genesys_chat_get_chats_user_settings
Get a user’s chat settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
genesys_chat_get_chats_users_me_settings
Get a user’s chat settingsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_chat_patch_chats_room
Set properties for a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
description | string | No | — | Room’s description |
ownerIds | string[] | No | — | Room’s owners |
pinnedMessageIds | string[] | No | — | Room’s pinned messages |
subject | string | No | — | Room’s subject |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"description": {
"type": "string",
"description": "Room's description"
},
"ownerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Room's owners"
},
"pinnedMessageIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Room's pinned messages"
},
"subject": {
"type": "string",
"description": "Room's subject"
}
},
"required": [
"PCID",
"roomJid"
]
}
genesys_chat_patch_chats_room_message
Edit a message in a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomId |
messageId | string | Yes | — | Message Id |
mentions | string[] | No | — | user ids to be notified |
message | string | Yes | — | The body of the message |
threadId | string | No | — | The thread id of the message |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "roomId"
},
"messageId": {
"type": "string",
"description": "Message Id"
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "user ids to be notified"
},
"message": {
"type": "string",
"description": "The body of the message"
},
"threadId": {
"type": "string",
"description": "The thread id of the message"
}
},
"required": [
"PCID",
"roomJid",
"messageId",
"message"
]
}
genesys_chat_patch_chats_settings
Patch Chat Settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageRetentionPeriodDays | integer | No | — | Retention time for messages in days, expressed as int in the range [10,3650] |
reactionsEnabled | boolean | No | — | Reactions enabled for org |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageRetentionPeriodDays": {
"type": "integer",
"description": "Retention time for messages in days, expressed as int in the range [10,3650]"
},
"reactionsEnabled": {
"type": "boolean",
"description": "Reactions enabled for org"
}
},
"required": [
"PCID"
]
}
genesys_chat_patch_chats_user_message
Edit a message to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
messageId | string | Yes | — | Message Id |
mentions | string[] | No | — | user ids to be notified |
message | string | Yes | — | The body of the message |
threadId | string | No | — | The thread id of the message |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"messageId": {
"type": "string",
"description": "Message Id"
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "user ids to be notified"
},
"message": {
"type": "string",
"description": "The body of the message"
},
"threadId": {
"type": "string",
"description": "The thread id of the message"
}
},
"required": [
"PCID",
"userId",
"messageId",
"message"
]
}
genesys_chat_patch_chats_user_settings
Update a user’s chat settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
mobile | object | Yes | — | Settings for mobile devices |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"mobile": {
"type": "object",
"description": "Settings for mobile devices",
"properties": {
"notifications": {
"type": "object",
"description": "Settings for a user's mobile notifications"
}
},
"required": [
"notifications"
]
}
},
"required": [
"PCID",
"userId",
"mobile"
]
}
genesys_chat_patch_chats_users_me_settings
Update a user’s chat settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mentionsOnly | boolean | No | — | Whether or not to enable notifications for mentions only |
mobile | object | Yes | — | Settings for mobile devices |
muted | boolean | No | — | Whether or not to enable muting notifications |
notifyOnReactions | boolean | No | — | Whether or not to enable notifications for reactions on a user’s own messages |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"mentionsOnly": {
"type": "boolean",
"description": "Whether or not to enable notifications for mentions only"
},
"mobile": {
"type": "object",
"description": "Settings for mobile devices",
"properties": {
"notifications": {
"type": "object",
"description": "Settings for a user's mobile notifications"
}
},
"required": [
"notifications"
]
},
"muted": {
"type": "boolean",
"description": "Whether or not to enable muting notifications"
},
"notifyOnReactions": {
"type": "boolean",
"description": "Whether or not to enable notifications for reactions on a user's own messages"
}
},
"required": [
"PCID",
"mobile"
]
}
genesys_chat_post_chats_room_messages
Send a message to a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomId |
mentions | string[] | No | — | user ids to be notified |
message | string | Yes | — | The body of the message |
threadId | string | No | — | The thread id of the message |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "roomId"
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "user ids to be notified"
},
"message": {
"type": "string",
"description": "The body of the message"
},
"threadId": {
"type": "string",
"description": "The thread id of the message"
}
},
"required": [
"PCID",
"roomJid",
"message"
]
}
genesys_chat_post_chats_room_messages_pins
Add pinned messages for a room, up to a maximum of 5 pinned messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
pinnedMessageIds | string[] | Yes | — | Ids of the messages to pin |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"pinnedMessageIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Ids of the messages to pin"
}
},
"required": [
"PCID",
"roomJid",
"pinnedMessageIds"
]
}
genesys_chat_post_chats_room_participant
Join a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | Room Jid |
userId | string | Yes | — | User Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomJid": {
"type": "string",
"description": "Room Jid"
},
"userId": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"roomJid",
"userId"
]
}
genesys_chat_post_chats_rooms
Create an adhoc room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Room’s description |
subject | string | Yes | — | Room’s subject |
userIds | string[] | No | — | Users to add to the room, limit of 25 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Room's description"
},
"subject": {
"type": "string",
"description": "Room's subject"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Users to add to the room, limit of 25"
}
},
"required": [
"PCID",
"subject"
]
}
genesys_chat_post_chats_user_messages
Send a message to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
mentions | string[] | No | — | user ids to be notified |
message | string | Yes | — | The body of the message |
threadId | string | No | — | The thread id of the message |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "user ids to be notified"
},
"message": {
"type": "string",
"description": "The body of the message"
},
"threadId": {
"type": "string",
"description": "The thread id of the message"
}
},
"required": [
"PCID",
"userId",
"message"
]
}
genesys_chat_post_chats_user_messages_pins
Add pinned messages for a 1on1, up to a maximum of 5 pinned messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
pinnedMessageIds | string[] | Yes | — | Ids of the messages to pin |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"pinnedMessageIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Ids of the messages to pin"
}
},
"required": [
"PCID",
"userId",
"pinnedMessageIds"
]
}
genesys_chat_post_chats_users_me_settings
Create a user’s chat settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mentionsOnly | boolean | No | — | Whether or not to enable notifications for mentions only |
muted | boolean | Yes | — | Whether or not to enable muting notifications |
notifyOnReactions | boolean | No | — | Whether or not to enable notifications for reactions on a user’s own messages |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"mentionsOnly": {
"type": "boolean",
"description": "Whether or not to enable notifications for mentions only"
},
"muted": {
"type": "boolean",
"description": "Whether or not to enable muting notifications"
},
"notifyOnReactions": {
"type": "boolean",
"description": "Whether or not to enable notifications for reactions on a user's own messages"
}
},
"required": [
"PCID",
"muted"
]
}
genesys_chat_put_chats_message_reactions
Update reactions to a message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message Id |
reactions | string[] | Yes | — | Reactions to update |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "Message Id"
},
"reactions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Reactions to update"
}
},
"required": [
"PCID",
"messageId",
"reactions"
]
}
genesys_chat_put_chats_settings
Update Chat Settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageRetentionPeriodDays | integer | No | — | Retention time for messages in days, expressed as int in the range [10,3650] |
reactionsEnabled | boolean | No | — | Reactions enabled for org |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageRetentionPeriodDays": {
"type": "integer",
"description": "Retention time for messages in days, expressed as int in the range [10,3650]"
},
"reactionsEnabled": {
"type": "boolean",
"description": "Reactions enabled for org"
}
},
"required": [
"PCID"
]
}

