AhaSend · Schema

CreateSingleMessageResponse

CreateSingleMessageResponse schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
object string Object type identifier
id string Message ID (null if the message was not sent)
recipient object
status string Status of the message
error string Error message if the message was not sent
schedule object Provided if the request contained a schedule
View JSON Schema on GitHub

JSON Schema

openapi-v2-create-single-message-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-schema/openapi-v2-create-single-message-response-schema.json",
  "title": "CreateSingleMessageResponse",
  "description": "CreateSingleMessageResponse schema from AhaSend API",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "message"
      ],
      "description": "Object type identifier",
      "example": "message"
    },
    "id": {
      "type": "string",
      "nullable": true,
      "description": "Message ID (null if the message was not sent)",
      "example": "<[email protected]>"
    },
    "recipient": {
      "$ref": "#/components/schemas/Recipient"
    },
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "scheduled",
        "error"
      ],
      "description": "Status of the message",
      "example": "queued"
    },
    "error": {
      "type": "string",
      "nullable": true,
      "description": "Error message if the message was not sent",
      "example": "example_value"
    },
    "schedule": {
      "$ref": "#/components/schemas/MessageSchedule",
      "description": "Provided if the request contained a schedule"
    }
  },
  "required": [
    "object",
    "recipient",
    "status"
  ]
}