Users

Get scheduled message

Retrieves details of a specific scheduled message by ID. Returns the message content, scheduled send time, and status.

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

Path parameters

scheduled_message_idstring required

The scheduled message id

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.