Current section
Files
Jump to
Current section
Files
priv/docs/methods/pins.add.json
{
"args": {
"channel": {
"desc": "Channel to pin the messsage to. You must also include a `timestamp` when pinning messages. Both the `channel` and `timestamp` arguments are functionally 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.",
"required": true,
"type": "string"
},
"timestamp": {
"desc": "Timestamp of the message to pin. You must also include the `channel`. Both the `channel` and `timestamp` arguments are functionally 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.",
"required": false,
"type": "string"
}
},
"desc": "Pins an item to a channel.",
"errors": {
"already_pinned": "The specified item is already pinned to the channel.",
"bad_timestamp": "Value passed for `timestamp` was invalid.",
"channel_not_found": "The `channel` argument was not specified or was invalid",
"external_channel_migrating": "Channel is undergoing an active migration.",
"file_not_found": "File not found.",
"file_not_shared": "File specified by `file` is not public nor shared to the channel.",
"message_not_found": "Message specified by `channel` and `timestamp` does not exist.",
"no_item_specified": "One of `file`, `file_comment`, or `timestamp` was not specified.",
"not_in_channel": "Item is not in channel.",
"not_pinnable": "This message type is not pinnable.",
"restricted_action": "The user does not have permission to add pins to the channel.",
"too_many_pins": "Too many pins in channel."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "pins:write",
"url": "https://docs.slack.dev/reference/scopes/pins.write"
}
],
"user": [
{
"name": "pins:write",
"url": "https://docs.slack.dev/reference/scopes/pins.write"
}
]
}
}