Messages

List scheduled messages

List future scheduled messages. Transient undo holds are omitted unless include_held is true.

get/scheduled-messages

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/scheduled-messages
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

include_heldboolean
searchstring
limitinteger

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Scheduled message list.

object'scheduled_message_list' required
totalinteger required

Changes

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