/chat.scheduleMessage - Slack Web API

Schedules a message to be sent to a channel.

{ "channel": "C1H9RESGL", "message": { "attachments": [ { "fallback": "This is an attachment's fallback", "id": 1, "text": "This is an attachment" } ], "bot_id": "B19LU7CSY", "subtype": "bot_message", "text": "Here's a message for you in the future", "type": "delayed_message", "username": "ecto1" }, "ok": true, "post_at": "1562180400", "scheduled_message_id": "Q1298393284" }

Request

Header Params

token

string

optional

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, instead of as a bot. Defaults to false. See chat.postMessage.

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

optional

Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.

link_names

string

optional

Find and link channel names and usernames.

parse

string

optional

Change how messages are treated. Defaults to none. See chat.postMessage.

post_at

string

optional

Unix EPOCH timestamp of time in future to send the message.

reply_broadcast

string

optional

Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

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

number

optional

Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.

unfurl_links

string

optional

Pass true to enable unfurling of primarily text-based content.

unfurl_media

string

optional

Pass false to disable unfurling of media content.

Responses

🟢200Typical success response

application/json

Body

Schema for successful response of chat.scheduleMessage method

channel

string

required

Match pattern:

^[CGD][A-Z0-9]{8,}$

message

object

required

bot_id

string

required

Match pattern:

^B[A-Z0-9]{8,}$

bot_profile

object (Bot Profile Object)

optional

team

string

required

Match pattern:

^[T][A-Z0-9]{2,}$

text

string

required

type

string

required

user

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

username

string

optional

enum<boolean>

required

Allowed value:

true

post_at

integer

required

scheduled_message_id

string

Scheduled Message ID

required

Match pattern:

^[Q][A-Z0-9]{8,}$

🔴500Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)