Create SMTP Credentials via the API

Create SMTP username and password credentials through the AhaSend API to authenticate with the SMTP relay, scoped to specific sending domains or global.

POST /v2/accounts/{account_id}/smtp-credentials

AhaSend Go SDK

Go

package main

import (
  "context"
  "fmt"
  "log"

  "github.com/AhaSend/ahasend-go/api"
  "github.com/AhaSend/ahasend-go/models/requests"
  "github.com/google/uuid"
)

func main() {
  // Create API client with authentication
  client := api.NewAPIClient(
    api.WithAPIKey("aha-sk-your-64-character-key"),
  )

  accountID := uuid.New()

  // Create context for the API call
  ctx := context.Background()

  // Call the ping endpoint
  response, httpResp, err := client.SMTPCredentialsAPI.CreateSMTPCredential(
    ctx,
    accountID,
    requests.CreateSMTPCredentialRequest{
      Name: "My SMTP Credential",
      Scope: "global",
      Sandbox: true,
    },
  )
  if err != nil {
    log.Fatalf("Error creating SMTP credentials: %v", err)
  }

  // Check response
  if httpResp.StatusCode == 201 {
    fmt.Printf("✅ Status: %d\n", httpResp.StatusCode)
    if response != nil {
      fmt.Printf("Created SMTP credentials: %#v\n", response)
    }
  } else {
    fmt.Printf("❌ Unexpected status code: %d\n", httpResp.StatusCode)
  }
}

201

{
  "object": "credential_smtp",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "username": "<string>",
  "sandbox": true,
  "scope": "global",
  "domains": [
    "<string>"
  ],
  "password": "<string>"
}

The AhaSend API creates a new SMTP credential for SMTP authentication. A scoped credential requires at least one domain and the key must have write permission for every supplied domain. A global credential requires smtp-credentials:write:all; supplied domains are accepted but ignored, and the response contains domains: []. SMTP credentials have no update endpoint.

Related Guides

• API authentication, Permission scopes, SMTP credential setup.
• SMTP credential CLI, SMTP settings, API errors.
• API rate limits, Plans and limits.

Authorizations

BearerAuthBearerAuth

Authorization · string · header · required

API key for authentication. Non-empty Security Requirement values are AhaSend API-key roles. Roles listed within one requirement object are jointly required; separate requirement objects are alternatives.

Headers

Idempotency-Key · string

Optional idempotency key for safe request retries. Must be a unique string for each logical request. An identical request with a completed stored outcome returns the original status and body. An in-progress execution returns 409, a changed method/path/body returns 422, and a released 5xx execution may run again. Keys for non-secret responses expire after 24 hours. API-key create responses include a one-time secret_key, so successful encrypted replay responses for those operations expire after 5 minutes.

Maximum string length: 255

Path Parameters

account_id · string<uuid> · required

Account ID

Body

application/json

name · string · required

Credential name

Maximum string length: 255

scope · enum<string> · required

Credential scope - "global" or "scoped"

Available options: global, scoped

sandbox · boolean · default: false

Whether this is a sandbox credential

domains · string[] | null

For scoped, a non-empty array is required. For global, this may be omitted, null, empty, or non-empty; supplied values are accepted but ignored.

Response

201

application/json

SMTP credential created successfully

object · enum<string> · required

Object type identifier

Available options: credential_smtp

id · string<uuid> · required

Unique identifier for the SMTP credential

created_at · string<date-time> · required

When the credential was created

updated_at · string<date-time> · required

When the credential was last updated

name · string · required

Credential name

username · string · required

SMTP username

sandbox · boolean · required

Whether this is a sandbox credential

scope · enum<string> · required

Credential scope

Available options: global, scoped

domains · string[] · required

Domains this credential can send from. Always present; global credentials return an empty array.

password · string · required

SMTP password. Returned only when the credential is created.