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

# heartbeat-community

> Heartbeat Community - Manage users, groups, roles, and invitations

**Server path:** `/heartbeat-community` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                    | Description                                             |
| --------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| [`heartbeat_community_add_group_members`](#heartbeat_community_add_group_members)       | Add users to a group                                    |
| [`heartbeat_community_create_group`](#heartbeat_community_create_group)                 | Create a new group                                      |
| [`heartbeat_community_create_invitation`](#heartbeat_community_create_invitation)       | Create a new invitation link                            |
| [`heartbeat_community_create_pending_user`](#heartbeat_community_create_pending_user)   | Create a pending user who becomes active on first login |
| [`heartbeat_community_create_user`](#heartbeat_community_create_user)                   | Create a new user in the community                      |
| [`heartbeat_community_delete_group`](#heartbeat_community_delete_group)                 | Delete a group                                          |
| [`heartbeat_community_delete_user`](#heartbeat_community_delete_user)                   | Delete a user (preserves their historical content)      |
| [`heartbeat_community_find_user`](#heartbeat_community_find_user)                       | Find a user by email address                            |
| [`heartbeat_community_get_group`](#heartbeat_community_get_group)                       | Get a group by ID                                       |
| [`heartbeat_community_get_notifications`](#heartbeat_community_get_notifications)       | Get the number of pending notifications for a user      |
| [`heartbeat_community_get_user`](#heartbeat_community_get_user)                         | Get a user by ID                                        |
| [`heartbeat_community_list_groups`](#heartbeat_community_list_groups)                   | List all groups in the community                        |
| [`heartbeat_community_list_invitations`](#heartbeat_community_list_invitations)         | List all invitations in the community                   |
| [`heartbeat_community_list_roles`](#heartbeat_community_list_roles)                     | List all roles in the community                         |
| [`heartbeat_community_list_users`](#heartbeat_community_list_users)                     | List all users in the community                         |
| [`heartbeat_community_reactivate_user`](#heartbeat_community_reactivate_user)           | Reactivate a deactivated user                           |
| [`heartbeat_community_remove_group_members`](#heartbeat_community_remove_group_members) | Remove users from a group                               |
| [`heartbeat_community_update_group`](#heartbeat_community_update_group)                 | Update a group                                          |
| [`heartbeat_community_update_invitation`](#heartbeat_community_update_invitation)       | Add users to an existing invitation                     |
| [`heartbeat_community_update_user`](#heartbeat_community_update_user)                   | Update an existing user                                 |

***

## heartbeat\_community\_add\_group\_members

Add users to a group

**Parameters:**

| Parameter                       | Type      | Required | Default | Description                                               |
| ------------------------------- | --------- | -------- | ------- | --------------------------------------------------------- |
| `groupID`                       | string    | Yes      | —       | The group ID                                              |
| `emails`                        | string\[] | Yes      | —       | Email addresses of users to add                           |
| `shouldRemoveFromSiblingGroups` | boolean   | No       | —       | Remove the users from other groups sharing a parent group |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupID": {
        "type": "string",
        "description": "The group ID"
      },
      "emails": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Email addresses of users to add"
      },
      "shouldRemoveFromSiblingGroups": {
        "type": "boolean",
        "description": "Remove the users from other groups sharing a parent group"
      }
    },
    "required": [
      "PCID",
      "groupID",
      "emails"
    ]
  }
  ```
</Expandable>

***

## heartbeat\_community\_create\_group

Create a new group

**Parameters:**

| Parameter       | Type      | Required | Default | Description                                 |
| --------------- | --------- | -------- | ------- | ------------------------------------------- |
| `description`   | string    | No       | —       | Group description                           |
| `isIsolated`    | boolean   | No       | —       | Whether the group is isolated               |
| `isJoinable`    | boolean   | No       | —       | Whether users can join the group themselves |
| `members`       | string\[] | No       | —       | Email addresses of users to add             |
| `name`          | string    | Yes      | —       | Group name                                  |
| `parentGroupID` | string    | No       | —       | Parent group ID for nested groups           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "description": {
        "type": "string",
        "description": "Group description"
      },
      "isIsolated": {
        "type": "boolean",
        "description": "Whether the group is isolated"
      },
      "isJoinable": {
        "type": "boolean",
        "description": "Whether users can join the group themselves"
      },
      "members": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Email addresses of users to add"
      },
      "name": {
        "type": "string",
        "description": "Group name"
      },
      "parentGroupID": {
        "type": "string",
        "description": "Parent group ID for nested groups"
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## heartbeat\_community\_create\_invitation

Create a new invitation link

**Parameters:**

| Parameter  | Type      | Required | Default | Description                                   |
| ---------- | --------- | -------- | ------- | --------------------------------------------- |
| `groupIDs` | string\[] | Yes      | —       | Groups joining members will be added to       |
| `roleID`   | string    | Yes      | —       | Role for members who join via this invitation |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupIDs": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "uuid"
        },
        "description": "Groups joining members will be added to"
      },
      "roleID": {
        "type": "string",
        "description": "Role for members who join via this invitation"
      }
    },
    "required": [
      "PCID",
      "groupIDs",
      "roleID"
    ]
  }
  ```
</Expandable>

***

## heartbeat\_community\_create\_pending\_user

Create a pending user who becomes active on first login

**Parameters:**

| Parameter        | Type      | Required | Default | Description                    |
| ---------------- | --------- | -------- | ------- | ------------------------------ |
| `bio`            | string    | No       | —       | User biography                 |
| `email`          | string    | Yes      | —       | Email address (must be unique) |
| `groupIDs`       | string\[] | No       | —       | Groups to add the user to      |
| `name`           | string    | Yes      | —       | User's full name               |
| `profilePicture` | string    | No       | —       | Profile picture as a data URI  |
| `roleID`         | string    | Yes      | —       | Role to assign                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "bio": {
        "type": "string",
        "description": "User biography"
      },
      "email": {
        "type": "string",
        "description": "Email address (must be unique)"
      },
      "groupIDs": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "uuid"
        },
        "description": "Groups to add the user to"
      },
      "name": {
        "type": "string",
        "description": "User's full name"
      },
      "profilePicture": {
        "type": "string",
        "description": "Profile picture as a data URI"
      },
      "roleID": {
        "type": "string",
        "description": "Role to assign"
      }
    },
    "required": [
      "PCID",
      "email",
      "name",
      "roleID"
    ]
  }
  ```
</Expandable>

***

## heartbeat\_community\_create\_user

Create a new user in the community

**Parameters:**

| Parameter                  | Type      | Required | Default | Description                                                   |
| -------------------------- | --------- | -------- | ------- | ------------------------------------------------------------- |
| `bio`                      | string    | No       | —       | User biography                                                |
| `createIntroductionThread` | boolean   | No       | —       | If true and bio is provided, generates an introduction thread |
| `email`                    | string    | Yes      | —       | Email address (must be unique to the community)               |
| `groupIDs`                 | string\[] | No       | —       | Groups to add the user to                                     |
| `instagram`                | string    | No       | —       | Instagram handle                                              |
| `linkedin`                 | string    | No       | —       | LinkedIn profile URL                                          |
| `name`                     | string    | Yes      | —       | User's full name                                              |
| `profilePicture`           | string    | No       | —       | Profile picture as a data URI (JPG/GIF/PNG)                   |
| `roleID`                   | string    | Yes      | —       | Role to assign to the user                                    |
| `status`                   | string    | No       | —       | User status text                                              |
| `twitter`                  | string    | No       | —       | Twitter handle                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "bio": {
        "type": "string",
        "description": "User biography"
      },
      "createIntroductionThread": {
        "type": "boolean",
        "description": "If true and bio is provided, generates an introduction thread"
      },
      "email": {
        "type": "string",
        "description": "Email address (must be unique to the community)"
      },
      "groupIDs": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "uuid"
        },
        "description": "Groups to add the user to"
      },
      "instagram": {
        "type": "string",
        "description": "Instagram handle"
      },
      "linkedin": {
        "type": "string",
        "description": "LinkedIn profile URL"
      },
      "name": {
        "type": "string",
        "description": "User's full name"
      },
      "profilePicture": {
        "type": "string",
        "description": "Profile picture as a data URI (JPG/GIF/PNG)"
      },
      "roleID": {
        "type": "string",
        "description": "Role to assign to the user"
      },
      "status": {
        "type": "string",
        "description": "User status text"
      },
      "twitter": {
        "type": "string",
        "description": "Twitter handle"
      }
    },
    "required": [
      "PCID",
      "email",
      "name",
      "roleID"
    ]
  }
  ```
</Expandable>

***

## heartbeat\_community\_delete\_group

Delete a group

**Parameters:**

| Parameter | Type   | Required | Default | Description  |
| --------- | ------ | -------- | ------- | ------------ |
| `groupID` | string | Yes      | —       | The group ID |

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

***

## heartbeat\_community\_delete\_user

Delete a user (preserves their historical content)

**Parameters:**

| Parameter | Type   | Required | Default | Description                 |
| --------- | ------ | -------- | ------- | --------------------------- |
| `email`   | string | Yes      | —       | Email of the user to delete |

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

***

## heartbeat\_community\_find\_user

Find a user by email address

**Parameters:**

| Parameter | Type   | Required | Default | Description                     |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `email`   | string | Yes      | —       | The email address to search for |

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

***

## heartbeat\_community\_get\_group

Get a group by ID

**Parameters:**

| Parameter | Type   | Required | Default | Description  |
| --------- | ------ | -------- | ------- | ------------ |
| `groupID` | string | Yes      | —       | The group ID |

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

***

## heartbeat\_community\_get\_notifications

Get the number of pending notifications for a user

**Parameters:**

| Parameter | Type   | Required | Default | Description               |
| --------- | ------ | -------- | ------- | ------------------------- |
| `email`   | string | Yes      | —       | Email address of the user |

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

***

## heartbeat\_community\_get\_user

Get a user by ID

**Parameters:**

| Parameter | Type   | Required | Default | Description                  |
| --------- | ------ | -------- | ------- | ---------------------------- |
| `userID`  | string | Yes      | —       | The user's unique identifier |

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

***

## heartbeat\_community\_list\_groups

List all groups in the community

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

***

## heartbeat\_community\_list\_invitations

List all invitations in the community

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

***

## heartbeat\_community\_list\_roles

List all roles in the community

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

***

## heartbeat\_community\_list\_users

List all users in the community

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

***

## heartbeat\_community\_reactivate\_user

Reactivate a deactivated user

**Parameters:**

| Parameter | Type   | Required | Default | Description                     |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `email`   | string | Yes      | —       | Email of the user to reactivate |

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

***

## heartbeat\_community\_remove\_group\_members

Remove users from a group

**Parameters:**

| Parameter | Type      | Required | Default | Description                        |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `groupID` | string    | Yes      | —       | The group ID                       |
| `emails`  | string\[] | Yes      | —       | Email addresses of users to remove |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupID": {
        "type": "string",
        "description": "The group ID"
      },
      "emails": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Email addresses of users to remove"
      }
    },
    "required": [
      "PCID",
      "groupID",
      "emails"
    ]
  }
  ```
</Expandable>

***

## heartbeat\_community\_update\_group

Update a group

**Parameters:**

| Parameter     | Type    | Required | Default | Description                       |
| ------------- | ------- | -------- | ------- | --------------------------------- |
| `groupID`     | string  | Yes      | —       | The group ID                      |
| `description` | string  | No       | —       | Updated description               |
| `isIsolated`  | boolean | No       | —       | Whether the group is isolated     |
| `isJoinable`  | boolean | No       | —       | Whether users can join themselves |
| `name`        | string  | No       | —       | Updated group name                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupID": {
        "type": "string",
        "description": "The group ID"
      },
      "description": {
        "type": "string",
        "description": "Updated description"
      },
      "isIsolated": {
        "type": "boolean",
        "description": "Whether the group is isolated"
      },
      "isJoinable": {
        "type": "boolean",
        "description": "Whether users can join themselves"
      },
      "name": {
        "type": "string",
        "description": "Updated group name"
      }
    },
    "required": [
      "PCID",
      "groupID"
    ]
  }
  ```
</Expandable>

***

## heartbeat\_community\_update\_invitation

Add users to an existing invitation

**Parameters:**

| Parameter         | Type      | Required | Default | Description                              |
| ----------------- | --------- | -------- | ------- | ---------------------------------------- |
| `invitationID`    | string    | Yes      | —       | The invitation ID                        |
| `emails`          | string\[] | Yes      | —       | Email addresses to add to the invitation |
| `shouldSendEmail` | boolean   | Yes      | —       | Whether to send invitation emails        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "invitationID": {
        "type": "string",
        "description": "The invitation ID"
      },
      "emails": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Email addresses to add to the invitation"
      },
      "shouldSendEmail": {
        "type": "boolean",
        "description": "Whether to send invitation emails"
      }
    },
    "required": [
      "PCID",
      "invitationID",
      "emails",
      "shouldSendEmail"
    ]
  }
  ```
</Expandable>

***

## heartbeat\_community\_update\_user

Update an existing user

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                      |
| ---------------- | ------ | -------- | ------- | ------------------------------------------------ |
| `bio`            | string | No       | —       | Updated biography                                |
| `email`          | string | Yes      | —       | Email of the user to update (used as identifier) |
| `instagram`      | string | No       | —       | Instagram handle                                 |
| `linkedin`       | string | No       | —       | LinkedIn profile URL                             |
| `name`           | string | No       | —       | Updated name                                     |
| `profilePicture` | string | No       | —       | Profile picture as a data URI                    |
| `status`         | string | No       | —       | Updated status text                              |
| `twitter`        | string | No       | —       | Twitter handle                                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "bio": {
        "type": "string",
        "description": "Updated biography"
      },
      "email": {
        "type": "string",
        "description": "Email of the user to update (used as identifier)"
      },
      "instagram": {
        "type": "string",
        "description": "Instagram handle"
      },
      "linkedin": {
        "type": "string",
        "description": "LinkedIn profile URL"
      },
      "name": {
        "type": "string",
        "description": "Updated name"
      },
      "profilePicture": {
        "type": "string",
        "description": "Profile picture as a data URI"
      },
      "status": {
        "type": "string",
        "description": "Updated status text"
      },
      "twitter": {
        "type": "string",
        "description": "Twitter handle"
      }
    },
    "required": [
      "PCID",
      "email"
    ]
  }
  ```
</Expandable>