> ## Documentation Index > Fetch the complete documentation index at: https://ahasend.com/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > AhaSend stores all message data in the EU. See /facts. > The API base URL is https://api.ahasend.com. Send the API key in the Authorization: Bearer header. See /api-reference/authentication. > Use send.ahasend.com for SMTP. Ports 25, 587 and 2525 use STARTTLS. Port 465 is not supported. See /smtp. > For send-only integrations, create an API Key v2 under Credentials → Add and scope it to messages:send:{your-domain}. See /send-api/credentials and /api-reference/scopes. # Add a Sending Domain via the API > Add a sending domain to AhaSend with the API and get the SPF, DKIM, return-path and tracking DNS records to publish, with optional custom subdomains. The AhaSend API creates a new domain. \[!WARNING] The `dkim_private_key` and `dkim_selector` parameters are part of [DNS whitelabel](https://ahasend.com/docs/scale/dns-whitelabel.md) and work on Max accounts only. Bring-your-own DKIM uses RSA keys: 1024 bits minimum, 2048 bits recommended. See [plans and features](https://ahasend.com/docs/facts.md#plans-and-features). ## Related Guides * [API authentication](https://ahasend.com/docs/api-reference/authentication.md), [Permission scopes](https://ahasend.com/docs/api-reference/scopes.md), [Domain setup](https://ahasend.com/docs/domains.md). * [Domain CLI](https://ahasend.com/docs/cli/commands/domains.md), [DNS whitelabel](https://ahasend.com/docs/scale/dns-whitelabel.md), [API errors](https://ahasend.com/docs/api-reference/errors.md). * [API rate limits](https://ahasend.com/docs/api-reference/rate-limits.md). ## OpenAPI ````yaml openapi.yaml POST /v2/accounts/{account_id}/domains openapi: 3.1.0 info: title: AhaSend API v2 description: > The AhaSend API v2 allows you to send transactional emails, manage domains, webhooks, routes, API keys, and view statistics. ## Authentication All API requests must be authenticated using a Bearer token in the Authorization header: ``` Authorization: Bearer aha-sk-64-CHARACTER-RANDOM-STRING ``` ## Scopes API keys have specific scopes that control access to different resources and actions: ### Message Scopes - `messages:send:all` - Send messages from any domain in the account - `messages:send:{domain}` - Send messages from a specific domain - `messages:cancel:all` - Cancel messages from any domain - `messages:cancel:{domain}` - Cancel messages from a specific domain - `messages:read:all` - Read messages from any domain - `messages:read:{domain}` - Read messages from a specific domain ### Domain Scopes - `domains:read` - Read all domains - `domains:write` - Create and update domains - `domains:delete:all` - Delete any domain - `domains:delete:{domain}` - Delete a specific domain ### Account Scopes - `accounts:read` - Read account information - `accounts:write` - Update account settings - `accounts:billing` - Access billing information - `accounts:members:read` - Read account members - `accounts:members:add` - Add account members - `accounts:members:update` - Update account members - `accounts:members:remove` - Remove account members ### Webhook Scopes - `webhooks:read:all` - Read all webhooks - `webhooks:read:{domain}` - Read webhooks for a specific domain - `webhooks:write:all` - Create and update webhooks - `webhooks:write:{domain}` - Create and update webhooks for a specific domain - `webhooks:delete:all` - Delete any webhook - `webhooks:delete:{domain}` - Delete webhooks for a specific domain ### Route Scopes - `routes:read:all` - Read all routes - `routes:read:{domain}` - Read routes for a specific domain - `routes:write:all` - Create and update routes - `routes:write:{domain}` - Create and update routes for a specific domain - `routes:delete:all` - Delete any route - `routes:delete:{domain}` - Delete routes for a specific domain ### Suppression Scopes - `suppressions:read` - Read suppressions - `suppressions:write` - Create suppressions - `suppressions:delete` - Delete suppressions - `suppressions:wipe` - Delete the account's suppressions except protected ones (dangerous) ### Template Scopes - `templates:read` - Read transactional templates, their drafts and their published versions, and campaign templates - `templates:write` - Create and update transactional templates, and publish, discard and restore their drafts; create and update campaign templates - `templates:delete` - Delete transactional templates and campaign templates ### Campaign Scopes - `campaigns:read` - Read campaigns, their stats and their recipients - `campaigns:write` - Create, update and duplicate campaigns - `campaigns:delete` - Delete draft campaigns - `campaigns:send` - Send, unschedule and test-send campaigns ### Contact Scopes - `contacts:read` - Read contacts - `contacts:write` - Create and update contacts - `contacts:delete` - Delete contacts ### Contact lifecycle and attributes Contacts are account-global. A contact created through this API joins no list on its own; campaigns target lists, so add it to one with the Lists endpoints before a campaign can reach it. Contact subscription state and suppression records are independent: creating, updating, unsubscribing, resubscribing, or deleting a contact never creates, changes, or removes complaint, permanent, or protected suppressions. Prefer unsubscribe over delete when the goal is only to stop marketing mail, because unsubscribe is reversible and preserves contact history. Writable attribute keys and types come from the account's contact-attribute definitions managed in the dashboard; this API does not expose property definition CRUD. Writes accept only canonical values for those definitions, while reads remain legacy-safe and can return any recursively nested JSON value previously stored. An email used as `{id_or_email}` is a raw SDK argument and must be percent-encoded exactly once as a URL path segment by an HTTP client. For example, do not pre-encode `user+tag@example.com` before passing it to an SDK that encodes path parameters. ### List Scopes - `lists:read` - Read lists and list membership - `lists:write` - Create and update lists, and add or remove their contacts - `lists:delete` - Delete lists ### Lists and membership A list is a static, private, single opt-in container of contacts, and it is what a campaign targets. A membership carries its own `subscription_status` (`unconfirmed`, `confirmed`, `unsubscribed`, or `complained`), which is per-list consent and is independent of the contact's account-wide `unsubscribed` flag. A membership created without a status named is `confirmed`, because that is what a campaign reaches. `complained` is the mailbox provider's verdict, never writable, and a membership holding it is frozen. Deleting a list keeps its memberships, so an unsubscribe survives it. Removing a contact from a list deletes the membership row and discards that record with it, which is why unsubscribing is the reversible way to stop marketing mail on one list. Expanding a list's members with `include_contacts=true` requires `contacts:read` in addition to `lists:read`. ### Segment Scopes - `segments:read` - Read segments, their members and a contact's segments, and preview a definition - `segments:write` - Create and update segments - `segments:delete` - Delete segments ### Segments A segment is a saved set of rules over the account's contacts: their fields, their list memberships, and the campaigns they received, opened or clicked. AhaSend keeps its members up to date as that data changes, usually within a minute; rules about campaigns follow within an hour of a send, and relative times such as `30 days ago` are read again on a schedule. Membership is the rule match only, whatever the contact's consent: a campaign to a segment reaches the members who are enabled, not unsubscribed, not found invalid, and either confirmed on at least one list or on no list at all. A contact who unsubscribed from or complained on every list they were on, or has not confirmed a double opt-in, is not reached. A contact who unsubscribes from a segment send, or reports it as spam, gets no more marketing email from the account. ### SMTP Credentials Scopes - `smtp-credentials:read:all` - Read all SMTP credentials - `smtp-credentials:read:{domain}` - Read SMTP credentials for a specific domain - `smtp-credentials:write:all` - Create SMTP credentials - `smtp-credentials:write:{domain}` - Create SMTP credentials for a specific domain - `smtp-credentials:delete:all` - Delete any SMTP credentials - `smtp-credentials:delete:{domain}` - Delete SMTP credentials for a specific domain ### Statistics Scopes - `statistics-transactional:read:all` - Read all transactional statistics - `statistics-transactional:read:{domain}` - Read transactional statistics for a specific domain ### API Key Scopes - `api-keys:read` - Read API keys - `api-keys:write` - Create and update API keys - `api-keys:delete` - Delete API keys ### Sub-Account Scopes - `sub-accounts:read` - List and read sub accounts under the parent - `sub-accounts:write` - Create and update sub accounts - `sub-accounts:delete` - Soft-delete sub accounts - `sub-accounts:suspend` - Pause and resume sub accounts, and unpause their domains - `sub-accounts:usage` - Read per-sub-account usage and allocated cost - `sub-account-api-keys:read` - List and read API keys owned by sub accounts - `sub-account-api-keys:write` - Create and update API keys owned by sub accounts - `sub-account-api-keys:delete` - Delete API keys owned by sub accounts ## Rate Limiting - General API endpoints: 100 requests per second, 200 burst - Statistics endpoints: 1 request per second, 1 burst A request over the limit gets HTTP 429 with a `Retry-After` header: the number of seconds to wait before retrying. ## Pagination List endpoints use cursor-based pagination with the following parameters: - `limit`: Maximum number of items to return (default: 100, max: 100) - `after`: Pass `pagination.next_cursor` to fetch the next page - `before`: Pass `pagination.previous_cursor` to fetch the previous page `after` and `before` are mutually exclusive. A legacy `cursor` query may be accepted by parts of the server for backwards compatibility, but it is not part of the v2 public contract. ## Time Formats All timestamps must be in RFC3339 format, e.g., `2023-12-25T10:30:00Z` ## Idempotency The operations that explicitly declare the optional `Idempotency-Key` header support idempotency. Other POST operations do not gain idempotency implicitly. When the header is provided: - A fresh execution does not return `Idempotent-Replayed`. - A completed stored response is replayed with its original status and body and `Idempotent-Replayed: true`. - An unexpired in-progress execution returns HTTP 409 with `Idempotent-Replayed: false` and a positive integer `Retry-After` header. - Reusing a key with a different HTTP method, resolved request path, or request body returns HTTP 422. That response has neither `Idempotent-Replayed` nor `Retry-After`. - For ordinary idempotent operations, deterministic 2xx and 4xx outcomes produced after the idempotency middleware are stored and replayed. Authentication and IP-allow-list failures happen before idempotency and are therefore not stored. - The two secret-bearing API-key create operations use manual encrypted completion. They store and replay a successful 201, including the same one-time `secret_key`; a controller-produced 4xx is not stored and leaves the key in progress until its execution lease expires. - Create Segment and Test Campaign store and replay a 2xx only. A 4xx is not stored: it releases the key, so a retry with the same key runs again. - Server errors (5xx), handler failures, and panics are not stored. The key is released so retrying the same request with the same key re-executes it. The v2 API does not use an HTTP 412 failed-key tombstone. - Idempotency keys for non-secret responses expire after 24 hours. - Encrypted API-key creation replay responses expire after 5 minutes. ## IP Allow Lists Each API key can carry an `ip_allow_list`: a set of source IPs that restrict where the key may authenticate from. - Entries are CIDR blocks (e.g. `203.0.113.0/24`) or bare IPv4/IPv6 addresses (stored as a `/32` or `/128`). They are canonicalized and de-duplicated; the allow-all prefixes `0.0.0.0/0` and `::/0` are rejected, and at most 100 entries are allowed after de-duplication (a longer list is rejected with HTTP 400). - An empty list (the default) places no restriction. - When the list is non-empty, any authenticated request whose client IP is not covered by an entry is rejected with HTTP 403 on every v2 endpoint, regardless of the key's scopes. - Manage the list with the `ip_allow_list` field on the API-key create and update endpoints (including the sub-account API-key endpoints). - When a key updates its own `ip_allow_list` to a value that excludes the caller's current IP, the update is rejected with HTTP 409 to prevent self-lockout. Updating a sub-account key from a parent key has no such guard. version: 2.0.0 contact: email: support@ahasend.com license: name: MIT identifier: MIT servers: - url: https://api.ahasend.com description: Production server security: - BearerAuth: [] tags: - name: Utility description: Utility endpoints for health checks and diagnostics - name: API Keys description: Manage API keys for authentication and access control - name: Domains description: Manage sending domains - name: Messages description: Send and manage transactional messages - name: Accounts description: Manage account settings and members - name: Contacts description: Read, create, update, batch upsert, and delete account-global contacts - name: Templates description: >- Create, change, publish and delete the account's transactional templates, and read them with their drafts, their published versions and the variables a send must supply - name: Campaign Templates description: >- Create, change, read and delete the account's campaign templates, the designs a campaign copies when it is made from one - name: Campaigns description: >- Create, change, read, duplicate, delete, test and send the account's marketing campaigns, and read their stats and recipients - name: Lists description: Manage contact lists and the contacts on them - name: Segments description: >- Manage segments, the saved rules that keep a set of contacts up to date, and read their members - name: Suppressions description: Manage email suppressions - name: Routes description: Manage inbound email routing - name: Webhooks description: Manage webhook notifications - name: SMTP Credentials description: Manage SMTP authentication credentials - name: Statistics description: Access transactional email statistics - name: Message Events description: Webhooks for outbound message delivery events - name: Suppression Events description: Webhooks for suppression list changes - name: Domain Events description: Webhooks for domain configuration issues - name: Route Events description: Webhooks for inbound email routing paths: /v2/accounts/{account_id}/domains: post: tags: - Domains summary: Create Domain description: Creates a new domain operationId: createDomain parameters: - name: account_id in: path required: true description: Account ID schema: type: string format: uuid - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDomainRequest' responses: '201': description: Domain created successfully headers: Idempotent-Replayed: $ref: '#/components/headers/IdempotentReplayed' content: application/json: schema: $ref: '#/components/schemas/Domain' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: > Either the domain already exists on the account or the idempotency-key execution is in progress. The in-progress case is identified only by `Idempotent-Replayed: false` plus a positive integer `Retry-After`. A new duplicate-domain response has neither header; a stored replay of that response has `Idempotent-Replayed: true`. The message is not a stable discriminator. headers: Idempotent-Replayed: description: | `false` with a positive `Retry-After` means an execution is in progress. `true` means a stored duplicate-domain 409 was replayed. Absent means a fresh duplicate-domain conflict. schema: type: string enum: - 'true' - 'false' Retry-After: $ref: '#/components/headers/IdempotencyRetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': $ref: '#/components/responses/IdempotencyPayloadMismatch' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: - domains:write x-code-samples: - lang: go label: AhaSend Go SDK source: | package main import ( "context" "fmt" "log" "os" "github.com/AhaSend/ahasend-go/api" "github.com/AhaSend/ahasend-go/models/requests" "github.com/google/uuid" ) func main() { client := api.NewAPIClient(api.WithAPIKey(os.Getenv("AHASEND_API_KEY"))) accountID := uuid.MustParse(os.Getenv("AHASEND_ACCOUNT_ID")) ctx := context.Background() // The SDK sends a fresh Idempotency-Key with this POST and reuses it on // its own retries, so a retried request is not applied twice. response, _, err := client.DomainsAPI.CreateDomain(ctx, accountID, requests.CreateDomainRequest{ Domain: "example.com", }) if err != nil { log.Fatalf("Error creating domain: %v", err) } // Publish these records at your DNS provider. for _, record := range response.DNSRecords { fmt.Printf("%s %s %s\n", record.Type, record.Host, record.Content) } } - lang: javascript label: Node.js 22+ (AhaSend SDK) source: > import { AhaSendClient } from "@ahasend/sdk"; const client = AhaSendClient.fromEnv(); // The SDK sends a fresh Idempotency-Key automatically and reuses it on its own retries. const domain = await client.domains.create({ domain: "example.com" }); console.log("Domain created.", { id: domain.id, domain: domain.domain }); components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: > 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. schema: type: string maxLength: 255 example: user-12345-create-domain-20240101 schemas: CreateDomainRequest: type: object required: - domain properties: domain: type: string format: hostname description: Fully qualified domain name dkim_private_key: type: string description: > DKIM Private Key for the domain. Only RSA keys with a minimum key size of 1024 bits are supported. **Note:** This parameter is only supported on [Platform Partner](https://ahasend.com/partners) accounts. Key size of at least 1024 bits is supported; 2048 bit keys are strongly recommended for improved security. tracking_subdomain: type: string description: >- Optional custom tracking subdomain. Omit to use the default on create. Applies to both manual-DNS and managed-DNS domains. return_path_subdomain: type: string description: >- Optional custom return-path subdomain. Omit to use the default on create. Applies to both manual-DNS and managed-DNS domains. subscription_subdomain: type: string description: >- Optional custom subscription management subdomain. Omit to use the default on create. Applies to both manual-DNS and managed-DNS domains. media_subdomain: type: string description: >- Optional custom media subdomain. Omit to use the default on create. Applies to both manual-DNS and managed-DNS domains. dkim_rotation_interval_days: type: integer description: >- Optional custom DKIM rotation interval in days. Only supported for managed DNS domains on eligible plans. dkim_selector: type: - string - 'null' description: > Optional custom DKIM selector for the domain. Omit, send null, or send an empty or whitespace-only string to use the default selector (no per-domain override); the value is trimmed before it is interpreted, so whitespace-only input is treated as empty. When provided, it is normalized to lowercase and must be a single DNS label: 1-62 characters using lowercase letters, numbers, and hyphens only, without a leading or trailing hyphen. **Note:** This parameter is only supported on [Platform Partner](https://ahasend.com/partners) accounts. sending_type: type: string enum: - transactional - marketing description: >- The type of email that you send from the domain. Omit to create a transactional domain. Null and empty values are refused. example: domain: example.com tracking_subdomain: click return_path_subdomain: mail subscription_subdomain: preferences media_subdomain: media dkim_rotation_interval_days: 45 Domain: type: object properties: object: type: string enum: - domain description: Object type identifier id: type: string format: uuid description: Unique identifier for the domain created_at: type: string format: date-time description: When the domain was created updated_at: type: string format: date-time description: When the domain was last updated domain: type: string description: The domain name account_id: type: string format: uuid description: Account ID this domain belongs to dns_records: type: array items: $ref: '#/components/schemas/DNSRecord' description: DNS records required for domain verification last_dns_check_at: type: - string - 'null' format: date-time description: When DNS records were last checked dns_valid: type: boolean description: Whether all required DNS records are properly configured tracking_subdomain: type: - string - 'null' description: >- Custom tracking subdomain. Null means the account or product default is used. Applies to both manual-DNS and managed-DNS domains. return_path_subdomain: type: - string - 'null' description: >- Custom return-path subdomain. Null means the account or product default is used. Applies to both manual-DNS and managed-DNS domains. subscription_subdomain: type: - string - 'null' description: >- Custom subscription management subdomain. Null means the account or product default is used. Applies to both manual-DNS and managed-DNS domains. media_subdomain: type: - string - 'null' description: >- Custom media subdomain. Null means the account or product default is used. Applies to both manual-DNS and managed-DNS domains. dkim_rotation_interval_days: type: - integer - 'null' description: >- Custom DKIM rotation interval in days. Null means the account default is used. Only supported for managed DNS domains. dkim_selector: type: - string - 'null' description: > Per-domain DKIM selector override. Null means no per-domain override is set. This reports the configured per-domain override only, not the effective selector used for DKIM signing. The effective selector is resolved separately and can differ — for example, a selector locked after DNS verification takes precedence over this override. rotation_ready: type: boolean description: Whether the standby DKIM slot is ready for rotation. dsn_recipient: type: - string - 'null' description: Optional recipient address for delivery status notifications. sending_type: type: string enum: - transactional - marketing description: >- The type of email that you send from the domain. The sending type affects your deliverability. Marketing email from a transactional domain can get your account paused. paused: type: boolean description: >- Whether sending from the domain is paused. While the domain is paused, new email from it is refused, and you cannot delete or rename it. Your other domains continue to send. paused_at: type: - string - 'null' format: date-time description: >- When sending from the domain was paused. Null when the domain is not paused. pause_reason: type: - string - 'null' description: | The reason of the pause. Null when the domain is not paused. - `bounce_rate`: too many recent emails from the domain bounced. required: - object - id - created_at - updated_at - domain - account_id - dns_records - last_dns_check_at - dns_valid - tracking_subdomain - return_path_subdomain - subscription_subdomain - media_subdomain - dkim_rotation_interval_days - dkim_selector - rotation_ready - dsn_recipient - sending_type - paused - paused_at - pause_reason ErrorResponse: type: object description: | Human-readable API error. The server currently sends no stable machine error code. In particular, clients must not parse `message` to distinguish IP-allow-list, scope, ownership, plan, self-lockout, suppression-duplicate, or other errors that share an HTTP status. additionalProperties: false required: - message properties: message: type: string description: Error description example: message: Error message DNSRecord: type: object properties: type: type: string description: DNS record type (e.g., CNAME, TXT, MX) label: type: string description: Human-readable DNS record label host: type: string description: DNS record host/name content: type: string description: DNS record content/value required: type: boolean description: Whether this DNS record is required for domain verification propagated: type: boolean description: Whether this DNS record has been propagated and verified required: - type - host - content - required - propagated headers: IdempotentReplayed: description: > Indicates that this response is a stored replay of a previous identical request. When this header is absent, the response is not a stored replay. Ordinary fresh responses do not send `false`; that value is reserved for an in-progress 409. schema: type: string enum: - 'true' IdempotencyRetryAfter: description: | Positive whole number of seconds after which the in-progress execution lease may be retried with the same key and unchanged request. schema: type: integer minimum: 1 responses: IdempotencyPayloadMismatch: description: | Idempotency key was already used with a different HTTP method, resolved request path, or request body. This response includes neither `Idempotent-Replayed` nor `Retry-After`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: message: idempotency key was already used with a different request payload securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: aha-sk-64-CHARACTER-RANDOM-STRING description: | 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.