pins.add
Pins an item to a channel.
Facts
Method URL: | https://slack.com/api/pins.add | ||||||||
---|---|---|---|---|---|---|---|---|---|
Preferred HTTP method: | POST | ||||||||
Accepted content types: | application/x-www-form-urlencoded , application/json | ||||||||
Rate limiting: | Tier 2 | ||||||||
Works with: |
|
file
and file_comment
parameters beginning August 22, 2019.
This method pins a message to a particular conversation or channel.
Both the channel
and timestamp
arguments are required. The provided channel
should be the ID of a public or private channel you want to pin to and the timestamp
should be the ts
value of a message within that conversation.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
channel
Channel to pin the item in.
ExampleC1234567890
timestamp
Timestamp of the message to pin.
Example1234567890.123456
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
Response
Common successful response
Typical success response
{
"ok": true
}
Common error response
Typical error response
{
"error": "channel_not_found",
"ok": false
}
After processing, a pin_added
event is broadcast via the Events and RTM APIs.
Some objects cannot be pinned: channel join messages, files, and file comments. A not_pinnable
error is thrown when we "no can do."
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 |
message_not_found | Message specified by |
channel_not_found | The |
no_item_specified | One of |
already_pinned | The specified item is already pinned to the channel. |
permission_denied | The user does not have permission to add pins to the channel. |
file_not_shared | File specified by |
not_pinnable | This message type is not pinnable. |
not_in_channel | Item is not in channel. |
file_not_found | File not found. |
too_many_pins | Too many pins in channel. |
external_channel_migrating | Channel is undergoing an 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. |
not_allowed_token_type | The token type used in this request is not allowed. |
method_deprecated | The method has been deprecated. |
deprecated_endpoint | The endpoint has been deprecated. |
two_factor_setup_required | Two factor setup is required. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments. |
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 |
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 |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
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. |
ratelimited | The request has been ratelimited. Refer to the |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
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. |
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 |
superfluous_charset | The method was called via a |