AhaSend · Schema

Recipient

Recipient schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
email string Recipient email address
name string Display name for the recipient
substitutions object Substitution data for the recipient. Used with jinja2 templating language for dynamic content
View JSON Schema on GitHub

JSON Schema

openapi-v2-recipient-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-recipient-schema.json",
  "title": "Recipient",
  "description": "Recipient schema from AhaSend API",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "Recipient email address",
      "example": "[email protected]"
    },
    "name": {
      "type": "string",
      "description": "Display name for the recipient",
      "example": "Example Name"
    },
    "substitutions": {
      "type": "object",
      "additionalProperties": true,
      "description": "Substitution data for the recipient. Used with jinja2 templating language for dynamic content",
      "example": {}
    }
  },
  "required": [
    "email"
  ],
  "example": {
    "email": "[email protected]",
    "name": "John Doe",
    "substitutions": {
      "first_name": "John",
      "order_id": "12345"
    }
  }
}