Slack. Web. Bookmarks
(SlackKit v0.25.0-alpha.0)
View Source
Summary
Functions
Add bookmark to a channel.
Edit bookmark.
List bookmark for the channel.
Remove bookmark from the channel.
Functions
Add bookmark to a channel.
Required Params
title- Title for the bookmark. Bookmarking alinkrequires:channel_id,title,type, and aurl:type- Type of the bookmark i.e link. Bookmarking alinkrequires:channel_id,title,type, and aurl:
Optional Params
access_level- The level that we are setting the file's permission to (read or write)
Acceptable values: read write
channel_id- Channel to add bookmark in. Required for public channels. Bookmarking alinkrequires:channel_id,title,type, and aurl:emoji- Emoji tag to apply to the link.entity_id- ID of the entity being bookmarked. Only applies to message and file types.link- Link to bookmark. Bookmarking alinkrequires:channel_id,title,type, and aurl:parent_id- Id of this bookmark's parent
Errors the API can return:
parent_with_link- Parent bookmark should not have link.too_many_tabs- tab limit reached for channel.invalid_link- Invalid link, link should begin with either http:// or https://.token_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.too_many_requests- Too many concurrent requests. Please retry.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.two_factor_setup_required- Two factor setup is required.invalid_shortcut_type- Shortcut type is not valid.invalid_form_data- The method was called via aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.invalid_parent_type- Parent type is not valid.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.slack_connect_blocked_file_type- Files with certain extensions are blocked from being uploaded in all Slack Connect communicationsdeprecated_endpoint- The endpoint has been deprecated.ratelimited- The request has been ratelimited. Refer to theRetry-Afterheader for when to retry the request.ekm_access_denied- Administrators have suspended the ability to post a message.service_unavailable- The service is temporarily unavailableslack_connect_clip_sharing_blocked- Admin has disabled Clip sharing in Slack Connect channelsteam_access_not_granted- The token used is not granted the specific workspace access required to complete this request.invalid_arguments- The method was called with invalid arguments.permission_denied- No permission to perform this operation.invalid_array_arg- The method was passed an array as an argument. Please only input valid strings.invalid_entity_id- Invalid entity_id, file or message type bookmark should have original file or message ID.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.account_inactive- Authentication token is for a deleted user or workspace when using abottoken.slack_connect_file_upload_sharing_blocked- Admin has disabled File uploads in all Slack Connect communicationschannel_not_found- Channel cannot be found.cannot_bookmark_restricted_sharing_enabled- File has restricted sharing enabled and cannot be bookmarked.not_authed- No authentication token provided.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.enterprise_is_restricted- The method cannot be called from an Enterprise.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.invalid_child_type- Child type is not valid.not_implemented- bookmarking not available for the user.access_denied- Actor lacks access to the requested resource.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.missing_scope- The token used is not granted the specific scope permissions required to complete this request.missing_post_type- The method was called via aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.accesslimited- Access to this method is limited on the current networkfile_already_added- The file has already been added to the folder.too_many_bookmarks- Bookmark limit reached for channel.token_expired- Authentication token has expiredinvalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.invalid_app_action_type- App action type is not valid.method_deprecated- The method has been deprecated.cannot_bookmark_from_external_org- File is an external file and cannot be bookmarked.invalid_emoji- Invalid emoji, does not follow the pattern of a valid emoji name.file_not_found- File cannot be found.not_allowed_token_type- The token type used in this request is not allowed.parent_bookmark_disabled- Parent bookmark feature flag is off.org_login_required- The workspace is undergoing an enterprise migration and will not be available until migration is complete.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.invalid_bookmark_type- Bookmark type is not valid.
Edit bookmark.
Optional Params
bookmark_id- Bookmark to update. Required for public channels.channel_id- Channel to update bookmark in. Required for public channels.emoji- Emoji tag to apply to the link.link- Link to bookmark.title- Title for the bookmark.
Errors the API can return:
not_found- Bookmark cannot be found.parent_with_link- Parent bookmark should not have link.invalid_link- Invalid link, link should begin with either http:// or https://.token_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.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.two_factor_setup_required- Two factor setup is required.invalid_form_data- The method was called via aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.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.slack_connect_blocked_file_type- Files with certain extensions are blocked from being uploaded in all Slack Connect communicationsdeprecated_endpoint- The endpoint has been deprecated.ratelimited- The request has been ratelimited. Refer to theRetry-Afterheader for when to retry the request.ekm_access_denied- Administrators have suspended the ability to post a message.service_unavailable- The service is temporarily unavailableslack_connect_clip_sharing_blocked- Admin has disabled Clip sharing in Slack Connect channelsteam_access_not_granted- The token used is not granted the specific workspace access required to complete this request.invalid_arguments- The method was called with invalid arguments.permission_denied- No permission to perform this operation.invalid_array_arg- The method was passed an array as an argument. Please only input valid strings.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.account_inactive- Authentication token is for a deleted user or workspace when using abottoken.slack_connect_file_upload_sharing_blocked- Admin has disabled File uploads in all Slack Connect communicationschannel_not_found- Channel cannot be found.not_authed- No authentication token provided.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.enterprise_is_restricted- The method cannot be called from an Enterprise.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.not_implemented- bookmarking not available for the user.access_denied- Actor lacks access to the requested resource.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.missing_scope- The token used is not granted the specific scope permissions required to complete this request.missing_post_type- The method was called via aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.accesslimited- Access to this method is limited on the current networktoken_expired- Authentication token has expiredinvalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.method_deprecated- The method has been deprecated.invalid_emoji- Invalid emoji, does not follow the pattern of a valid emoji name.not_allowed_token_type- The token type used in this request is not allowed.org_login_required- The workspace is undergoing an enterprise migration and will not be available until migration is complete.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.invalid_bookmark_type- Bookmark type is not valid.
List bookmark for the channel.
Optional Params
channel_id- Channel to list bookmarks in. Required for public channels.
Errors the API can return:
access_denied- Actor lacks access to the requested resource.accesslimited- Access to this method is limited on the current networkaccount_inactive- Authentication token is for a deleted user or workspace when using abottoken.channel_not_found- Channel cannot be found.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.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 called with invalid arguments.invalid_array_arg- The method was passed an array as an argument. Please only input valid strings.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.invalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.invalid_form_data- The method was called via aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.method_deprecated- The method has been deprecated.missing_post_type- The method was called via aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.missing_scope- The token used is not granted the specific scope permissions required to complete this request.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.not_allowed_token_type- The token type used in this request is not allowed.not_authed- No authentication token provided.not_implemented- bookmarking not available for the user.org_login_required- The workspace is undergoing an enterprise migration and will not be available until migration is complete.ratelimited- The request has been ratelimited. Refer to theRetry-Afterheader for when to retry the request.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.service_unavailable- The service is temporarily unavailableteam_access_not_granted- The token used is not granted the specific workspace access required to complete this request.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.token_expired- Authentication token has expiredtoken_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.two_factor_setup_required- Two factor setup is required.
Remove bookmark from the channel.
Optional Params
bookmark_id- Bookmark to remove. Required for public channels.channel_id- Channel to remove bookmark. Required for public channels.quip_section_id- Quip section ID to unbookmark
Errors the API can return:
not_found- Bookmark cannot be found.token_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.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.two_factor_setup_required- Two factor setup is required.invalid_form_data- The method was called via aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.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.deprecated_endpoint- The endpoint has been deprecated.ratelimited- The request has been ratelimited. Refer to theRetry-Afterheader for when to retry the request.ekm_access_denied- Administrators have suspended the ability to post a message.service_unavailable- The service is temporarily unavailableuser_not_found- User cannot be found.team_access_not_granted- The token used is not granted the specific workspace access required to complete this request.invalid_arguments- The method was called with invalid arguments.permission_denied- No permission to perform this operation.invalid_array_arg- The method was passed an array as an argument. Please only input valid strings.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.account_inactive- Authentication token is for a deleted user or workspace when using abottoken.channel_not_found- Channel cannot be found.not_authed- No authentication token provided.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.enterprise_is_restricted- The method cannot be called from an Enterprise.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.not_implemented- bookmarking not available for the user.access_denied- Actor lacks access to the requested resource.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.missing_scope- The token used is not granted the specific scope permissions required to complete this request.missing_post_type- The method was called via aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.accesslimited- Access to this method is limited on the current networktoken_expired- Authentication token has expiredinvalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.method_deprecated- The method has been deprecated.not_allowed_token_type- The token type used in this request is not allowed.org_login_required- The workspace is undergoing an enterprise migration and will not be available until migration is complete.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.invalid_bookmark_type- Bookmark type is not valid.