AhaSend · JSON Structure

Openapi V2 Create Smtp Credential Request Structure

CreateSMTPCredentialRequest schema from AhaSend API

Type: object Properties: 4 Required: 2
EmailTransactional EmailDeveloper ToolsSMTPWebhooks

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

Properties

name 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-create-smtp-credential-request-structure.json",
  "name": "CreateSMTPCredentialRequest",
  "description": "CreateSMTPCredentialRequest schema from AhaSend API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "description": "Credential name",
      "example": "Example Name"
    },
    "sandbox": {
      "type": "boolean",
      "description": "Whether this is a sandbox credential",
      "default": false,
      "example": true
    },
    "scope": {
      "type": "string",
      "enum": [
        "global",
        "scoped"
      ],
      "description": "Credential scope - \"global\" or \"scoped\"",
      "example": "global"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Required if scope is \"scoped\"",
      "example": [
        "mail.example.com"
      ]
    }
  },
  "required": [
    "name",
    "scope"
  ],
  "example": {
    "name": "Production SMTP",
    "username": "smtp_user",
    "password": "secure_password",
    "scope": "global"
  }
}