conversations.setPurpose
Sets the purpose for a conversation.
Facts
Method URL: | https://slack.com/api/conversations.setPurpose | ||||||||
---|---|---|---|---|---|---|---|---|---|
Preferred HTTP method: | POST | ||||||||
Accepted content types: | application/x-www-form-urlencoded , application/json | ||||||||
Rate limiting: | Tier 2 | ||||||||
Works with: |
|
channels:
, groups:
, im:
or mpim:
scopes corresponding to the conversation type you're working with.
This method is used to change the purpose of a conversation. The calling user must be a member of the conversation. Not all conversation types may have a purpose set.
This method cannot be called with bot user tokens belonging to Slack apps, although legacy bot tokens will work. To use this method in a Slack app, use a user token imbued with the necessary scope. Stay tuned for updates as we bring a fuller feast of features to bots belonging to Slack apps.
Limits for workspace apps
Because workspace apps can't act on behalf of users, they don't have the power to set the purpose of conversations, except when they're already part of the 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
Conversation to set the purpose of
ExampleC1234567890
purpose
A new, specialer purpose
ExampleMy More Special Purpose
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
Response
{
"ok": true,
"purpose": "I didn't set this purpose on purpose!"
}
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 |
---|---|
channel_not_found | Value passed for |
not_in_channel | Authenticated user is not in the channel. |
is_archived | Channel has been archived. |
too_long | Purpose was longer than 250 characters. |
user_is_restricted | This method cannot be called by a restricted user or single channel guest. |
method_not_supported_for_channel_type | This type of conversation cannot be used with this method. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
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 when using a |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed when using a |
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. |
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 |