Bookmarks
Retrieves the list of bookmarks for the channel.
Select
You must specify the ChannelId column in the WHERE clause to query the Bookmarks table. The add-in will use the Slack API to process search criteria that refer to the ChannelId columns. These columns support server-side processing for the = operator. The add-in processes other filters client-side within the add-in.
For example, the following queries are processed server side by the Slack APIs:
SELECT * FROM Bookmarks WHERE ChannelId = 'C01KWCPJJ68'
Insert
ChannelId, Title, and Type are required for inserting a bookmark. Title, Type, Emoji, EntityId, Link, AccessLevel, and ParentId are the only columns that can be set on an insert.
INSERT INTO Bookmarks (ChannelId, Title, Type, Link) VALUES ('C01KWCPJJ68', 'Test Bookmark', 'link', 'https://app.slack.com/archives/C01KWCPJJ68/p1735804757564799')
INSERT INTO Bookmarks (ChannelId, Title, Type, Link, Emoji, AccessLevel) VALUES ('C01KWCPJJ68', 'Test Bookmark', 'link', 'https://app.slack.com/archives/C01KWCPJJ68/p1735804757564799', ':clap:', 'write')
Update
The Bookmarks table allows updates for columns Title, Link, and Emoji when Id and ChannelId are specified.
UPDATE Bookmarks SET Link='https://cdatasoftware.slack.com/archives/C01KWCPJJ68/p1733740400267539' WHERE ChannelId = 'C01KWCPJJ68' and Id = 'Bk0871NJJQD8' Update Bookmarks SET Title='Test Bookmark Update' WHERE ChannelId = 'C01KWCPJJ68' and Id = 'Bk0871NJJQD8'
Delete
Bookmarks can be deleted by providing the ChannelId and the Id of the Bookmark.
DELETE FROM Bookmarks WHERE ChannelId = 'D71R6CSR1' AND Id = 'Bk0871NJJQD8'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the bookmark | |
| ChannelId | String | True |
The Id of the channel. | |
| AppId | String | False |
The App Id. | |
| DateCreated | Datetime | True |
The date when the bookmark was created. | |
| DateUpdated | Datetime | True |
The date when the bookmark was updated. | |
| Emoji | String | False |
The emoji tag added to the bookmark. | |
| EntityId | String | False |
The Id of the entity being bookmarked. | |
| IconUrl | String | True |
The URL of the icon. | |
| LastUpdatedByTeamId | String | True |
The Id of the team who last updated the bookmark. | |
| LastUpdatedByUserId | String | True |
The Id of the user who last updated the bookmark. | |
| Link | String | False |
Link to bookmark. | |
| Rank | String | False |
The rank of the bookmark. | |
| ShortcutId | String | True |
The shortcut Id. | |
| Title | String | False |
Title of the bookmark. | |
| Type | String | False |
Type of the bookmark. Supported values are 'link'. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| AccessLevel | String |
The level that we are setting the file's permission to (read or write). |
| ParentId | String |
Id of the bookmark's parent. |
| QuipSectionId | String |
Quip section ID to unbookmark. |