Fluxmail

List scheduled sends

List scheduled messages in an email account.

GET /api/v1/accounts/{accountId}/scheduled-sends

List scheduled messages in an email account.

Authentication

Pass a Fluxmail API key as a bearer token. The key determines the member, mailbox scope, and permissions for the request.

Request

curl 'http://localhost:8977/api/v1/accounts/acct_123/scheduled-sends' \
  -H "Authorization: Bearer $FLUXMAIL_API_KEY"

Parameters

NameLocationRequiredTypeDetails
accountIdpathYesstringMinimum length: 1.

Responses

StatusDescriptionContent type
200Scheduled sendsapplication/json
400Invalid requestapplication/json
401Authentication requiredapplication/json
403Permission or plan deniedapplication/json
404Resource not foundapplication/json
409Request conflictapplication/json
422Unsupported capabilityapplication/json
429Provider rate limitapplication/json
500Internal errorapplication/json
503Provider unavailableapplication/json

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scheduleId": {
            "type": "string"
          },
          "accountId": {
            "type": "string"
          },
          "draftId": {
            "type": "string"
          },
          "sendAt": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "sending",
              "sent",
              "failed",
              "canceled"
            ]
          },
          "attempts": {
            "type": "integer",
            "minimum": 0
          },
          "subject": {
            "type": "string"
          },
          "to": {
            "type": "string"
          },
          "lastError": {
            "type": "string"
          },
          "sentMessageId": {
            "type": "string"
          },
          "sentThreadId": {
            "type": "string"
          }
        },
        "required": [
          "scheduleId",
          "accountId",
          "draftId",
          "sendAt",
          "status",
          "attempts"
        ],
        "additionalProperties": false
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Last updated