AhaSend · Schema

SMTPCredential

SMTPCredential schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
object string Object type identifier
id string Unique identifier for the SMTP credential
created_at string When the credential was created
updated_at string When the credential was last updated
name string Credential name
username string SMTP username
sandbox boolean Whether this is a sandbox credential
scope string Credential scope
domains array Domains this credential can send from
View JSON Schema on GitHub

JSON Schema

openapi-v2-smtp-credential-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-smtp-credential-schema.json",
  "title": "SMTPCredential",
  "description": "SMTPCredential schema from AhaSend API",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "smtp_credential"
      ],
      "description": "Object type identifier",
      "example": "smtp_credential"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the SMTP credential",
      "example": "500123"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the credential was created",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the credential was last updated",
      "example": "2025-03-15T14:30:00Z"
    },
    "name": {
      "type": "string",
      "description": "Credential name",
      "example": "Example Name"
    },
    "username": {
      "type": "string",
      "description": "SMTP username",
      "example": "Example Name"
    },
    "sandbox": {
      "type": "boolean",
      "description": "Whether this is a sandbox credential",
      "example": true
    },
    "scope": {
      "type": "string",
      "enum": [
        "global",
        "scoped"
      ],
      "description": "Credential scope",
      "example": "global"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Domains this credential can send from",
      "example": [
        "mail.example.com"
      ]
    }
  },
  "required": [
    "object",
    "id",
    "created_at",
    "updated_at",
    "name",
    "username",
    "sandbox",
    "scope"
  ]
}