Sign inGet Started
शुरू करें
गाइड
API Reference
SDKs
CLI
Knowledge Base
Changelog

Get a scheduled mailbox send

GET
/v1/email/mailboxes/{mailbox_id}/scheduled-messages/{scheduled_message_id}
bird email mailboxes scheduled-messages get <mailbox-id> <scheduled-message-id>
प्रतिक्रिया200
{
  "id": "msm_01krdgeqcxet5s7t44vh8rt9mg",
  "mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
  "thread_id": "thr_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "scheduled",
  "scheduled_at": "2026-05-20T10:00:00Z",
  "cancel_on_reply": false,
  "recipients": [
    "customer@example.com"
  ],
  "subject": "Your request",
  "snippet": "Here is the reply.",
  "created_by": {
    "id": "usr_01krdgeqcxet5s7t44vh8rt9mg",
    "type": "user"
  },
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-20T09:14:52Z"
}

Read the scheduled send and its dispatch, failure or cancellation state. The actual message enters the conversation only at dispatch.

पैरामीटर

mailbox_idstring

Mailbox that owns the scheduled send.

scheduled_message_idstring

Scheduled send identifier from scheduled_message_id in the acceptance response.

Response Payload

id
string
आवश्यक

Scheduled send identifier.

mailbox_id
string
आवश्यक

Mailbox that owns the send.

thread_id
string
आवश्यक

Reserved conversation identifier. A new compose does not create the conversation until dispatch.

message_id
string

Actual message identifier once handed to the send pipeline.

status
string
आवश्यक
  • scheduled: Waiting for its due time; cancellation is still possible.
  • sending: Dispatch has been claimed; cancellation is no longer possible.
  • sent: Handed to the ordinary send pipeline, not necessarily delivered. Follow message_id for delivery status.
  • failed: Terminal dispatch refusal or failure; see failure_reason. The schedule will not retry.
  • canceled: Terminal cancellation before dispatch; see cancellation_reason. The message will not send.

Possible values: scheduled, sending, sent, failed, canceled

scheduled_at
string
आवश्यक

Scheduled at.

cancel_on_reply
boolean
आवश्यक

Whether an inbound message cancels this send before dispatch is claimed.

failure_reason
string

Why dispatch failed.

cancellation_reason
string

Why canceled; replied means new inbound mail canceled an opted-in schedule.

subject
string
आवश्यक

Frozen subject.

snippet
string
आवश्यक

Plain-text preview of the frozen message.

recipients
array of string
आवश्यक

Visible recipients (To and Cc). Bcc addresses remain only in the frozen send payload.

created_by
object
आवश्यक

Authenticated caller that scheduled the send.

चाइल्ड एट्रिब्यूट दिखाएँ
created_by.id
string
आवश्यक

Actor identifier.

created_by.type
string
आवश्यक

New actor types may be added. Treat unrecognized values as future types, not errors.

  • user: a member's own session.
  • api_key: a workspace API key.
  • oauth_token: a token issued to a caller on a member's behalf.
  • system: an action we perform without a customer actor.
  • sso: an organization's SSO connection.
  • service_account: a workspace's connected Integration acting with no member behind it.
  • automation: an automation execution in your workspace.

Possible values (may grow over time): user, api_key, oauth_token, system, sso, service_account, automation

created_by.display_name
nullable string

The label the actor is shown under: typically a member's name or email address, or the API key's name. Null when it could not be resolved.

created_at
string
आवश्यक
updated_at
string
आवश्यक

संबंधित संसाधन

इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।

इम्प्लीमेंटेशन ब्रीफ़ पाएँ