Messages waiting to be sent

GET/api/v1/mailbox/messages/scheduled

Requires amailbox token— it acts as one mailbox holder, not as the organization.

Send times for everything in the Scheduled folder, keyed by the same message id the folder listing returns, so a client merges the two rather than fetching the messages twice. Includes any that FAILED: a scheduled message that did not go out is the one the holder most needs to see.

Request

GET/api/v1/mailbox/messages/scheduled

curl -X GET 'https://app.mailyte.com/api/v1/mailbox/messages/scheduled' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

const response = await fetch('https://app.mailyte.com/api/v1/mailbox/messages/scheduled', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer MAILBOX_TOKEN',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/mailbox/messages/scheduled",
    headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('MAILBOX_TOKEN')
    ->get('https://app.mailyte.com/api/v1/mailbox/messages/scheduled');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/mailbox/messages/scheduled")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Successful Response

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.