stars.add.md

Adds a star to an item.

Facts

| Method URL: | https://slack.com/api/stars.add | | Preferred HTTP method: | POST | | Accepted content types: | application/x-www-form-urlencoded, application/json | | Rate limiting: | Tier 2 | | Works with: |

Token type	Required scope(s)
bot	stars:write
user	stars:write
classic bot	bot

|

---

This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified.

Arguments

Argument	Example	Required	Description
token	xxxx-xxxxxxxxx-xxxx	Required	Authentication token bearing required scopes.
channel	C1234567890	Optional	Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
file	F1234567890	Optional	File to add star to.
file_comment	Fc1234567890	Optional	File comment to add star to.
timestamp	1234567890.123456	Optional	Timestamp of the message to add star to.

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

Response

{
    "ok": true
}

After making this call, the item will be starred and a star_added event is broadcast through the RTM API for the calling user.

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
bad_timestamp	Value passed for timestamp was invalid.
message_not_found	Message specified by channel and timestamp does not exist.
file_not_found	File specified by file does not exist.
file_comment_not_found	File comment specified by file_comment does not exist.
channel_not_found	Channel, private group, or DM specified by channel does not exist
no_item_specified	file, file_comment, channel and timestamp was not specified.
already_starred	The specified item has already been starred by the authenticated user.
external_channel_migrating	Channel is undergoing active migration
not_authed	No authentication token provided.
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.
account_inactive	Authentication token is for a deleted user or workspace.
token_revoked	Authentication token is for a deleted user or workspace or the app has been removed.
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.
ekm_access_denied	Administrators have suspended the ability to post a message.
missing_scope	The token used is not granted the specific scope permissions required to complete this request.
invalid_arguments	The method was called with invalid arguments.
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_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.
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.
request_timeout	The method was called via a POST request, but the POST data was either missing or truncated.
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.

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
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.