Sign in
Users

Update scheduled message

Updates an existing scheduled message before it is sent. Can modify message content, scheduled time, and timezone. Returns updated scheduled message details.

patch/users/@me/scheduled-messages/{scheduled_message_id}

Path parameters

scheduled_message_idstring required

The scheduled message id

Request body

contentstring

The message content. Non-premium users can send up to 2000 characters; premium users, bots, and webhooks can send up to 4000 characters.

flagsinteger

Message flags bitfield

noncestring

Client-generated identifier for the message

favorite_meme_idstring snowflake
sticker_idsSnowflakeType[] nullable

Array of sticker IDs to include (max 3)

ttsboolean

Whether this is a text-to-speech message

scheduled_local_atstring required

ISO 8601 timestamp expressed in the user local timezone for when the message should be delivered

timezonestring required

IANA timezone identifier the schedule_local_at value is anchored to

Response

Success

idstring required

The unique identifier for this scheduled message

channel_idstring required

The ID of the channel this message will be sent to

scheduled_atstring required

The ISO 8601 UTC timestamp when the message is scheduled to be sent

scheduled_local_atstring required

The ISO 8601 timestamp in the user local timezone

timezonestring required

The IANA timezone identifier used for scheduling

status'pending' | 'invalid' | 'scheduled' | 'sent' | 'failed' | 'cancelled' required

The current status of the scheduled message

status_reasonstring nullable required

A human-readable reason for the current status, if applicable

created_atstring required

The ISO 8601 timestamp when this scheduled message was created

invalidated_atstring nullable required

The ISO 8601 timestamp when the message was marked invalid

Changes

No recorded changes to this endpoint across all 1 revision of this API.