AhaSend · Schema

SuccessfulResponse

SuccessfulResponse schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
success_count integer Number of messages that were queued for sending.
fail_count integer Number of messages that failed to be queued for sending.
failed_recipients array List of email addresses that the email was not sent to.
errors array
View JSON Schema on GitHub

JSON Schema

api-successful-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/api-successful-response-schema.json",
  "title": "SuccessfulResponse",
  "description": "SuccessfulResponse schema from AhaSend API",
  "type": "object",
  "properties": {
    "success_count": {
      "type": "integer",
      "description": "Number of messages that were queued for sending.",
      "example": 1
    },
    "fail_count": {
      "type": "integer",
      "description": "Number of messages that failed to be queued for sending.",
      "example": 1
    },
    "failed_recipients": {
      "type": "array",
      "description": "List of email addresses that the email was not sent to.",
      "example": [
        "[email protected]"
      ],
      "items": {
        "type": "string"
      }
    },
    "errors": {
      "type": "array",
      "example": [
        "[email protected]: The email account that you tried to reach does not exist."
      ],
      "items": {
        "type": "string",
        "description": "The reason the email failed to be sent to a recipient."
      }
    }
  }
}