AhaSend · JSON Structure

Openapi V2 Smtp Credential Structure

SMTPCredential schema from AhaSend API

Type: object Properties: 9 Required: 8
EmailTransactional EmailDeveloper ToolsSMTPWebhooks

SMTPCredential is a JSON Structure definition published by AhaSend, describing 9 properties, of which 8 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

object id created_at updated_at name username sandbox scope domains

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-structure/openapi-v2-smtp-credential-structure.json",
  "name": "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": "uuid",
      "description": "Unique identifier for the SMTP credential",
      "example": "500123"
    },
    "created_at": {
      "type": "datetime",
      "description": "When the credential was created",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "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"
  ]
}