bookmarks.add

View other methods

Add bookmark to a channel.

Reference docs Tester

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack.com/api/bookmarks.add

Bolt for Java

app.client().bookmarksAdd

Bolt for Python

app.client.bookmarks_add

Bolt for JavaScript

app.client.bookmarks.add

Required scopes

Bot tokensbookmarks:write

User tokensbookmarks:write

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 2

Arguments

Required arguments

token

token

·Required

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example

xxxx-xxxxxxxxx-xxxx

channel_id

string

·Required

Channel to add bookmark in.

Example

C1234567890

title

string

·Required

Title for the bookmark.

type

string

·Required

Type of the bookmark i.e link.

Optional arguments

access_level

enum

·Optional

The level that we are setting the file's permission to (read or write)

Value should be one ofreadwrite

emoji

string

·Optional

Emoji tag to apply to the link.

entity_id

string

·Optional

ID of the entity being bookmarked. Only applies to message and file types.

link

string

·Optional

Link to bookmark.

parent_id

string

·Optional

Id of this bookmark's parent

Usage info

Add bookmark to a channel.

This API method can add bookmarked resources to conversations.

Conversations are limited to 100 bookmarks.

Bookmarks can contain external links as well as internal resources such as messages, files, or other channels within Slack. These resources are readily available in the header of the Slack client near pinned messages.

Bookmarks in channel screenshot

The bookmarks.add method currently accepts the following types:

link

Bookmarking a link requires: channel_id, title, type, and a url:

https://slack.com/api/bookmarks.add?channel_id=C123TGZ4XYX&title=bookmark-example&type=link&link=http%3A%2F%2Fslack.com

Example responses

Common successful response

Typical success response

{
    "ok": true,
    "bookmark": {
        "id": "Bk033XFJ9BTJ",
        "channel_id": "C1RQ000",
        "title": "bookmark-1",
        "link": "https://google.com",
        "emoji": ":clap:",
        "icon_url": "https://www.google.com/favicon.ico",
        "type": "link",
        "entity_id": null,
        "date_created": 1644956055,
        "date_updated": 0,
        "rank": "g",
        "last_updated_by_user_id": "U0334B6G6G5",
        "last_updated_by_team_id": "T018DF03GHY",
        "shortcut_id": null,
        "app_id": null
    }
}

Common error response

Typical error response

{
    "ok": false,
    "error": "invalid_auth"
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error	Description
`access_denied`	Access to a resource specified in the request is denied.
`channel_not_found`	Channel cannot be found.
`file_not_found`	File cannot be found.
`invalid_bookmark_type`	Bookmark type is not valid.
`invalid_shortcut_type`	Shortcut type is not valid.
`invalid_child_type`	Child type is not valid.
`invalid_emoji`	Invalid emoji, does not follow the pattern of a valid emoji name.
`invalid_entity_id`	Invalid entity_id, file or message type bookmark should have original file or message ID.
`invalid_link`	Invalid link, link should begin with either http:// or https://.
`invalid_parent_type`	Parent type is not valid.
`not_implemented`	bookmarking not available for the user.
`parent_bookmark_disabled`	Parent bookmark feature flag is off.
`parent_with_link`	Parent bookmark should not have link.
`permission_denied`	No permission to perform this operation.
`too_many_bookmarks`	Bookmark limit reached for channel.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`deprecated_endpoint`	The endpoint has been deprecated.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`invalid_auth`	Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
`is_bot`	This method cannot be called by a legacy bot.
`method_deprecated`	The method has been deprecated.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`not_allowed_token_type`	The token type used in this request is not allowed.
`not_authed`	No authentication token provided.
`no_permission`	The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`token_expired`	Authentication token has expired
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`two_factor_setup_required`	Two factor setup is required.
`team_access_not_granted`	The token used is not granted the specific workspace access required to complete this request.
`accesslimited`	Access to this method is limited on the current network
`fatal_error`	The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
`internal_error`	The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.
`invalid_arg_name`	The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.
`invalid_arguments`	The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`invalid_charset`	The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.
`invalid_form_data`	The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.
`invalid_post_type`	The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`service_unavailable`	The service is temporarily unavailable
`team_added_to_org`	The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`found_existing_app`	Found an existing bookmark with the same app_action_id for this channel.
`found_existing_shortcut`	Found an existing bookmark with the same shortcut_id for this channel.
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.

API response

URL

POST body

Submit your arguments to see the API response