This Conversations API method's required scopes depend on the type of channel-like object you're working with. To use the method, you'll need at least one of the channels:, groups:, im: or mpim: scopes corresponding to the conversation type you're working with.
This method moves the read cursor in a conversation for whomever owns the token used in the request. We don't know why bot users would want to move their read cursor but it can be done.
The associated user must be a member of the channel.
Unique identifier of message you want marked as most recently seen in this conversation.
Example1593473566.000200
This method supports 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
{
"ok": false,
"error": "invalid_auth"
}
After making this call, the mark is saved to the database and broadcast via the message server to all open connections for the calling user.
Don't make calls to this method very often. When needing to mark a read position, a client should set a timer before making the call. In this way, any further updates needed during the timeout will not generate extra calls (just one per channel). This is useful for when reading scroll-back history, or following a busy live channel. A timeout of 5 seconds is a good starting point.
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 channel was invalid.
invalid_timestamp
Value passed for timestamp was invalid.
not_in_channel
Caller is not a member of the channel.
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 _. If you get this error, it is typically an indication that you have made a very malformed API call.
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 POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.
invalid_form_data
The method was called via a POST request with Content-Typeapplication/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/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/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.
ratelimited
The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
accesslimited
Access to this method is limited on the current network
request_timeout
The method was called via a POST request, but the POST data was either missing or truncated.
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 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.
