Scheduled Messages

Scheduled messages are messages queued to be sent at a future timestamp.

Scheduled Message Object

Represents a message queued to be sent later.

Scheduled Message Structure
FieldTypeDescription
user_idsnowflakeThe ID of the user who scheduled the message
scheduled_message_idsnowflakeThe ID of the scheduled message
send_at_timestampISO8601 timestampWhen the message will be sent
scheduled_messagescheduled message data objectThe message data to send
stateintegerThe current state of the scheduled message
attachment_uploads?array[scheduled attachment upload object]Uploaded attachments for the message
Scheduled Message Data Structure
FieldTypeDescription
channel_idsnowflakeThe ID of the destination channel
contentstringThe message content
typeintegerThe type of message
flagsintegerThe message flags
message_reference?message reference objectThe message reference
Scheduled Attachment Upload Structure
FieldTypeDescription
filenamestringThe original filename
uploaded_filenamestringThe uploaded attachment filename
description??stringThe attachment description
title??stringThe attachment title

Endpoints

Create Scheduled Message

POST/users/@me/scheduled-messages

Creates a scheduled message. Returns a scheduled message object on success.

JSON Params
FieldTypeDescription
channel_idsnowflakeThe ID of the channel
contentstringThe content
scheduled_timestampintegerThe scheduled timestamp
flagsintegerThe flags
message_referenceobjectThe message reference
allowed_mentionsobjectThe allowed mentions
attachments?objectThe attachments

List Scheduled Messages

GET/users/@me/scheduled-messages

Returns a list of scheduled message objects.

Modify Scheduled Message

PATCH/users/@me/scheduled-messages/{scheduled-message.id}

Modifies a scheduled message. Returns the updated scheduled message object on success.

JSON Params
FieldTypeDescription
scheduled_timestampintegerThe scheduled timestamp
contentstringThe content
flagsintegerThe flags

Delete Scheduled Message

DELETE/users/@me/scheduled-messages/{scheduled-message.id}

Cancels and deletes a scheduled message. Returns a 204 empty response on success.