Tool Reference
SetFavorite
Add an item to the user's favorites (shown starred in the app sidebar) or remove it, as the Favorite action does.
Starter documentation. Features and account details may differ from this deployment.
SetFavorite
Add an item to the user's favorites (shown starred in the app sidebar) or remove it, as the Favorite action does. Requires view access to add an item. List favorites with ListEntities and favoritesOnly.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
entityType | "document" | "project" | "channel" | "email" | "call" | "crm_company" | "crm_contact" | Yes | The kinds of item a user can favorite. |
entityId | string | Yes | The id of the item. |
favorite | boolean | Yes | True to add the item to favorites, false to remove it. |