Provide custom unfurl behavior for user-posted URLs


Method URL:
Preferred HTTP method:POST
Accepted content types:application/x-www-form-urlencoded, application/json
Rate limiting:Tier 3
Works with:
Token typeRequired scope(s)

This method attaches Slack app unfurl behavior to a specified and relevant message. A user token is required as this method does not support bot user tokens.

The first time this method is executed with a particular ts and channel combination, the valid unfurls attachments you provide will be attached to the message. Subsequent attempts with the same ts and channel values will modify the same attachments, rather than adding more.



Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.


Channel ID of the message


Timestamp of the message to add unfurl behavior to.


URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.


Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior


Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.


Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain

Default: 0


Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.


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

The provided ts value must correspond to a message in the specified channel. Additionally, the message must contain a fully-qualified URL pointing to a domain that is already registered and associated with your Slack app.

The unfurls parameter expects a URL-encoded string of JSON. Unlike chat.postMessage's attachments parameter, it does not expect a JSON array but instead, a hash keyed on the specific URLs you're offering an unfurl for. Each URL can have a single attachment, including message buttons.

Consult the unfurling docs for more guidance on this parameter.

The user_auth_required parameter is optional. By providing a 1 or true value, it will require the user posting the link first authenticate themselves with your app. See also the authenticated unfurling docs.

To point users to a specific page on your server to authenticate, pass a valid URL using the user_auth_url parameter. When sending this parameter via application/x-www-form-urlencoded GETs or POSTs, values must be URL-encoded such that becomes

Or, you can send an ephemeral message to that user by providing a simple string-based user_auth_message value or JSON array of blocks using user_auth_blocks. Simple slack message formatting like *bold*, _italics_, and linking is supported, so you can wrap your custom URLs in a blanket of situationally accurate, actionable text.

user_auth_message offers two default buttons, Not now and Never ask me again which allows your app to prompt a user multiple times before opting out of an install. To make your ephemeral message extra fancy, you can also use user_auth_blocks which will override the default buttons. Using both properties shows the user_auth_message in a notifcation and the user_auth_blocks in the ephemeral message.

Specifying user_auth_url or user_auth_message will automatically imply user_auth_required being set to true. If both user_auth_url and user_auth_message are provided, user_auth_message takes precedence.


Common successful response

Typical, minimal success response

    "ok": true
Common error response

Typical error response

    "ok": false,
    "error": "cannot_unfurl_url"

As you can see, we provide a minimal positive response when your unfurl attempt is successful. When it is not, you'll receive one of the errors below and ok will be false.


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.


The request is missing the channel parameter


The request is missing the ts parameter


The specified channel could not be located for this token.


A record of your app being allowed to unfurl for this workspace could not be found.


The provided unfurls argument could not be parsed or understood.


The request is missing the unfurls parameter.


The unfurls parameter cannot be JSON-decoded into a map of URLs to attachments.


The URL cannot be unfurled. This error may be returned if you haven't acknowledged a link_shared event tied to the same URL. It is also returned when the domain appears in a workspace's administrative blocklists.


The current user has already interacted with and dismissed a prompt for this application.


The ts value in the request does not match a message.


The URL cannot be unfurled because the URL provided does not appear in the message.


The current user cannot be authenticated.


No authentication token provided.


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.


Authentication token is for a deleted user or workspace when using a bot token.


Authentication token is for a deleted user or workspace or the app has been removed when using a user token.


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.


The workspace is undergoing an enterprise migration and will not be available until migration is complete.


Administrators have suspended the ability to post a message.


The token used is not granted the specific scope permissions required to complete this request.


The token type used in this request is not allowed.


The method has been deprecated.


The endpoint has been deprecated.


Two factor setup is required.


The method cannot be called from an Enterprise.


This method cannot be called by a bot user.


The token used is not granted the specific workspace access required to complete this request.


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.


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.


The method was passed an array as an argument. Please only input valid strings.


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.


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.


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.


The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.


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.


The request has been ratelimited. Refer to the Retry-After header for when to retry the request.


Access to this method is limited on the current network


The method was called via a POST request, but the POST data was either missing or truncated.


The service is temporarily unavailable


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.


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.


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.


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.


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.

Was this page helpful?