> ## 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-chat

> Genesys Chat - internal chat rooms, messages, participants, and settings

**Server path:** `/genesys-chat` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                          | Description                                                          |
| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [`genesys_chat_delete_chats_room_message`](#genesys_chat_delete_chats_room_message)           | Delete a message in a room                                           |
| [`genesys_chat_delete_chats_room_messages_pin`](#genesys_chat_delete_chats_room_messages_pin) | Remove a pinned message from a room                                  |
| [`genesys_chat_delete_chats_room_participant`](#genesys_chat_delete_chats_room_participant)   | Remove a user from a room.                                           |
| [`genesys_chat_delete_chats_user_message`](#genesys_chat_delete_chats_user_message)           | Delete a message to a user                                           |
| [`genesys_chat_delete_chats_user_messages_pin`](#genesys_chat_delete_chats_user_messages_pin) | Remove a pinned message from a 1on1                                  |
| [`genesys_chat_delete_chats_users_me_settings`](#genesys_chat_delete_chats_users_me_settings) | Delete a user's chat settings                                        |
| [`genesys_chat_get_chats_message`](#genesys_chat_get_chats_message)                           | Get a message                                                        |
| [`genesys_chat_get_chats_room`](#genesys_chat_get_chats_room)                                 | Get a room                                                           |
| [`genesys_chat_get_chats_room_message`](#genesys_chat_get_chats_room_message)                 | Get messages by id(s) from a room                                    |
| [`genesys_chat_get_chats_room_messages`](#genesys_chat_get_chats_room_messages)               | Get a room's message history                                         |
| [`genesys_chat_get_chats_room_participant`](#genesys_chat_get_chats_room_participant)         | Get a room participant                                               |
| [`genesys_chat_get_chats_room_participants`](#genesys_chat_get_chats_room_participants)       | Get room participants in a room                                      |
| [`genesys_chat_get_chats_settings`](#genesys_chat_get_chats_settings)                         | Get Chat Settings.                                                   |
| [`genesys_chat_get_chats_thread_messages`](#genesys_chat_get_chats_thread_messages)           | Get history by thread                                                |
| [`genesys_chat_get_chats_user`](#genesys_chat_get_chats_user)                                 | Get information for a 1on1                                           |
| [`genesys_chat_get_chats_user_message`](#genesys_chat_get_chats_user_message)                 | Get messages by id(s) from a 1on1                                    |
| [`genesys_chat_get_chats_user_messages`](#genesys_chat_get_chats_user_messages)               | Get 1on1 History between a user                                      |
| [`genesys_chat_get_chats_user_settings`](#genesys_chat_get_chats_user_settings)               | Get a user's chat settings                                           |
| [`genesys_chat_get_chats_users_me_settings`](#genesys_chat_get_chats_users_me_settings)       | Get a user's chat settings                                           |
| [`genesys_chat_patch_chats_room`](#genesys_chat_patch_chats_room)                             | Set properties for a room                                            |
| [`genesys_chat_patch_chats_room_message`](#genesys_chat_patch_chats_room_message)             | Edit a message in a room                                             |
| [`genesys_chat_patch_chats_settings`](#genesys_chat_patch_chats_settings)                     | Patch Chat Settings.                                                 |
| [`genesys_chat_patch_chats_user_message`](#genesys_chat_patch_chats_user_message)             | Edit a message to a user                                             |
| [`genesys_chat_patch_chats_user_settings`](#genesys_chat_patch_chats_user_settings)           | Update a user's chat settings                                        |
| [`genesys_chat_patch_chats_users_me_settings`](#genesys_chat_patch_chats_users_me_settings)   | Update a user's chat settings                                        |
| [`genesys_chat_post_chats_room_messages`](#genesys_chat_post_chats_room_messages)             | Send a message to a room                                             |
| [`genesys_chat_post_chats_room_messages_pins`](#genesys_chat_post_chats_room_messages_pins)   | Add pinned messages for a room, up to a maximum of 5 pinned messages |
| [`genesys_chat_post_chats_room_participant`](#genesys_chat_post_chats_room_participant)       | Join a room                                                          |
| [`genesys_chat_post_chats_rooms`](#genesys_chat_post_chats_rooms)                             | Create an adhoc room                                                 |
| [`genesys_chat_post_chats_user_messages`](#genesys_chat_post_chats_user_messages)             | Send a message to a user                                             |
| [`genesys_chat_post_chats_user_messages_pins`](#genesys_chat_post_chats_user_messages_pins)   | Add pinned messages for a 1on1, up to a maximum of 5 pinned messages |
| [`genesys_chat_post_chats_users_me_settings`](#genesys_chat_post_chats_users_me_settings)     | Create a user's chat settings                                        |
| [`genesys_chat_put_chats_message_reactions`](#genesys_chat_put_chats_message_reactions)       | Update reactions to a message                                        |
| [`genesys_chat_put_chats_settings`](#genesys_chat_put_chats_settings)                         | Update Chat Settings.                                                |

***

## 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  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## genesys\_chat\_delete\_chats\_users\_me\_settings

Delete a user's chat settings

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## genesys\_chat\_get\_chats\_message

Get a message

**Parameters:**

| Parameter   | Type   | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `messageId` | string | Yes      | —       | Message Id  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messageId": {
        "type": "string",
        "description": "Message Id"
      }
    },
    "required": [
      "PCID",
      "messageId"
    ]
  }
  ```
</Expandable>

***

## genesys\_chat\_get\_chats\_room

Get a room

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `roomJid` | string | Yes      | —       | Room Jid    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "roomJid": {
        "type": "string",
        "description": "Room Jid"
      }
    },
    "required": [
      "PCID",
      "roomJid"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## genesys\_chat\_get\_chats\_settings

Get Chat Settings.

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## genesys\_chat\_get\_chats\_user

Get information for a 1on1

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId`  | string | Yes      | —       | User Id     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "userId": {
        "type": "string",
        "description": "User Id"
      }
    },
    "required": [
      "PCID",
      "userId"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## genesys\_chat\_get\_chats\_user\_settings

Get a user's chat settings

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId`  | string | Yes      | —       | User ID     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "userId": {
        "type": "string",
        "description": "User ID"
      }
    },
    "required": [
      "PCID",
      "userId"
    ]
  }
  ```
</Expandable>

***

## genesys\_chat\_get\_chats\_users\_me\_settings

Get a user's chat settings

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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                                                     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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                                                     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>