AhaSend · Schema
CreateSMTPCredentialRequest
CreateSMTPCredentialRequest schema from AhaSend API
EmailTransactional EmailDeveloper ToolsSMTPWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Credential name |
| sandbox | boolean | Whether this is a sandbox credential |
| scope | string | Credential scope - "global" or "scoped" |
| domains | array | Required if scope is "scoped" |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-schema/openapi-v2-create-smtp-credential-request-schema.json",
"title": "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"
}
}