/chat.postEphemeral

POST

/chat.postEphemeral

chat

Sends an ephemeral message to a user in a channel.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/chat.postEphemeral' \
--header 'token;' \
--data-urlencode 'channel=' \
--data-urlencode 'user='

Response Example

200 - response

{
    "message_ts": "1502210682.580145",
    "ok": true
}

Request

Header Params

token

string

required

Authentication token. Requires scope: chat:write

Body Params application/x-www-form-urlencoded

as_user

string

optional

Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.

attachments

string

optional

A JSON-based array of structured attachments, presented as a URL-encoded string.

blocks

string

optional

A JSON-based array of structured blocks, presented as a URL-encoded string.

channel

string

required

Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

icon_emoji

string

optional

Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

icon_url

string

optional

URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

link_names

string

optional

Find and link channel names and usernames.

parse

string

optional

Change how messages are treated. Defaults to none. See below.

text

string

optional

How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

thread_ts

string

optional

Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.

user

string

required

id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.

username

string

optional

Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

Responses

🟢200Typical success response

application/json

Body

Schema for successful response from chat.postEphemeral method

message_ts

string

required

Match pattern:

^\d{10}\.\d{6}$

enum<boolean>

required

Allowed value:

true

🔴500Typical error response

/chat.meMessage

/chat.postMessage