Delivery response model

All models · Download OpenAPI

Nullable fields represent unknown values; they do not imply zero cost or a completed action.

Field	Type	Required	Details
id	string	No
actionId	string	No
channel	string	No	email or wechat
factoryId	string or null	No
toName	string or null	No
toAddress	string or null	No
cc	string[]	No
subject	string or null	No
bodyEn	string or null	No
bodyZh	string or null	No
status	string	No	draft, approved, queued, sending, delivery_unknown, delivery_failed, sent, rejected or needs_contact
transport	string or null	No
approvedAt	string or null	No
sentAt	string or null	No

Full JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "actionId": {
      "type": "string"
    },
    "channel": {
      "type": "string",
      "description": "email or wechat"
    },
    "factoryId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "toName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "toAddress": {
      "anyOf": [
        {
          "type": "string",
          "description": "Resolved from the factory at approval time, never supplied by the caller in live mode"
        },
        {
          "type": "null"
        }
      ]
    },
    "cc": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Both Maglev founders, always"
      }
    },
    "subject": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "bodyEn": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "bodyZh": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "description": "draft, approved, queued, sending, delivery_unknown, delivery_failed, sent, rejected or needs_contact"
    },
    "transport": {
      "anyOf": [
        {
          "type": "string",
          "description": "resend, resend_pending, outbox or manual"
        },
        {
          "type": "null"
        }
      ]
    },
    "approvedAt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "sentAt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  }
}