Learn about the other types used when reading, creating, updating, and deleting favorites via the API
The monday.com favorites API lets you query a user's favorites.
Each of the object types described below represents a specific aspect of a favorite. They can be queried as subfields on the favorites query or provide favorite metadata in mutations.
CreateFavoriteInput
An object containing the input of the new favorite to create.
| Field | Description | Input Fields | 
|---|---|---|
| name  | The name of the object to mark as a favorite. | |
| newPosition  | The new position of the favorite object. | nextObject  | 
| object  | The type of object to mark as a favorite. | id  | 
CreateFavoriteResultType
An object containing the result of creating a new favorite via the API.
| Field | Description | Supported Subfields | 
|---|---|---|
| favorites  | The new favorite object's metadata. | accountId  | 
DeleteFavoriteInput
An object containing the input of the favorite to delete.
| Field | Description | Input Fields | 
|---|---|---|
| object  | The object to remove from the favorites. | id  | 
DeleteFavoriteInputResultType
An object containing the result of deleting a favorite object via the API.
| Field | Description | 
|---|---|
| success Boolean | Whether the favorite was successfully deleted. | 
HierarchyObjectId
An object containing metadata about the favorited object.
| Field | Description | Enum values | 
|---|---|---|
| id  | The object's unique identifier. | |
| type  | The object's type. | 
 | 
HierarchyObjectIDInputType
Metadata about the favorite object.
| Field | Description | Enum Values | 
|---|---|---|
| id  | The object's unique identifier. | |
| type  | The object's type. | 
 | 
ListID
An object containing metadata about the favorited list.
| Field | Description | Enum values | 
|---|---|---|
| id  | The list's unique identifier. | |
| type  | The list's type. | 
 | 
UpdateObjectHierarchyPositionInput
An object containing the input of the favorite to update.
| Field | Description | Input Fields | 
|---|---|---|
| newFolder  | The unique identifier of the folder to move the favorite object into. | |
| newPosition  | The new position of the favorite object in the favorites list. | nextObject  | 
| object  | The favorite object to update. | 
UpdateFavoriteResultType
An object containing the result of updating a favorite object's position via the API.
| Field | Description | Supported Subfields | 
|---|---|---|
| favorites  | The updated favorite object's metadata. | accountId  | 
