Update a Sending Domain via the API

AhaSend Go SDK

package main

import (
  "context"
  "fmt"
  "log"

  ahasend "github.com/AhaSend/ahasend-go"
  "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()

  // Update domain settings
  response, httpResp, err := client.DomainsAPI.UpdateDomain(
    ctx,
    accountID,
    "example.com",
    requests.UpdateDomainRequest{
      TrackingSubdomain:        ahasend.String("click"),
      ReturnPathSubdomain:      ahasend.String("mail"),
      DKIMRotationIntervalDays: ahasend.Int(45),
    },
  )
  if err != nil {
    log.Fatalf("Error updating domain: %v", err)
  }

  fmt.Printf("Status: %d\n", httpResp.StatusCode)
  if response != nil {
    fmt.Printf("Updated domain: %s\n", response.Domain)
  }
}

import { AhaSendClient } from "@ahasend/sdk";

const client = AhaSendClient.fromEnv();
const domainName = "example.com";
const domain = await client.domains.update(domainName, { tracking_subdomain: "click" });
console.log("Domain updated.", { domain: domain.domain });

curl --request PUT \
  --url https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_subdomain": "click",
  "return_path_subdomain": "mail",
  "subscription_subdomain": "preferences",
  "media_subdomain": "media",
  "dkim_rotation_interval_days": 45
}
'

import requests

url = "https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain}"

payload = {
    "tracking_subdomain": "click",
    "return_path_subdomain": "mail",
    "subscription_subdomain": "preferences",
    "media_subdomain": "media",
    "dkim_rotation_interval_days": 45
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'tracking_subdomain' => 'click',
    'return_path_subdomain' => 'mail',
    'subscription_subdomain' => 'preferences',
    'media_subdomain' => 'media',
    'dkim_rotation_interval_days' => 45
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.put("https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tracking_subdomain\": \"click\",\n  \"return_path_subdomain\": \"mail\",\n  \"subscription_subdomain\": \"preferences\",\n  \"media_subdomain\": \"media\",\n  \"dkim_rotation_interval_days\": 45\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tracking_subdomain\": \"click\",\n  \"return_path_subdomain\": \"mail\",\n  \"subscription_subdomain\": \"preferences\",\n  \"media_subdomain\": \"media\",\n  \"dkim_rotation_interval_days\": 45\n}"

response = http.request(request)
puts response.read_body

{
  "object": "domain",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "domain": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dns_records": [
    {
      "type": "<string>",
      "host": "<string>",
      "content": "<string>",
      "required": true,
      "propagated": true,
      "label": "<string>"
    }
  ],
  "last_dns_check_at": "2023-11-07T05:31:56Z",
  "dns_valid": true,
  "tracking_subdomain": "<string>",
  "return_path_subdomain": "<string>",
  "subscription_subdomain": "<string>",
  "media_subdomain": "<string>",
  "dkim_rotation_interval_days": 123,
  "dkim_selector": "<string>",
  "rotation_ready": true,
  "dsn_recipient": "<string>"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

PUT

accounts

{account_id}

domains

{domain}

AhaSend Go SDK

package main

import (
  "context"
  "fmt"
  "log"

  ahasend "github.com/AhaSend/ahasend-go"
  "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()

  // Update domain settings
  response, httpResp, err := client.DomainsAPI.UpdateDomain(
    ctx,
    accountID,
    "example.com",
    requests.UpdateDomainRequest{
      TrackingSubdomain:        ahasend.String("click"),
      ReturnPathSubdomain:      ahasend.String("mail"),
      DKIMRotationIntervalDays: ahasend.Int(45),
    },
  )
  if err != nil {
    log.Fatalf("Error updating domain: %v", err)
  }

  fmt.Printf("Status: %d\n", httpResp.StatusCode)
  if response != nil {
    fmt.Printf("Updated domain: %s\n", response.Domain)
  }
}

import { AhaSendClient } from "@ahasend/sdk";

const client = AhaSendClient.fromEnv();
const domainName = "example.com";
const domain = await client.domains.update(domainName, { tracking_subdomain: "click" });
console.log("Domain updated.", { domain: domain.domain });

curl --request PUT \
  --url https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_subdomain": "click",
  "return_path_subdomain": "mail",
  "subscription_subdomain": "preferences",
  "media_subdomain": "media",
  "dkim_rotation_interval_days": 45
}
'

import requests

url = "https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain}"

payload = {
    "tracking_subdomain": "click",
    "return_path_subdomain": "mail",
    "subscription_subdomain": "preferences",
    "media_subdomain": "media",
    "dkim_rotation_interval_days": 45
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'tracking_subdomain' => 'click',
    'return_path_subdomain' => 'mail',
    'subscription_subdomain' => 'preferences',
    'media_subdomain' => 'media',
    'dkim_rotation_interval_days' => 45
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.put("https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tracking_subdomain\": \"click\",\n  \"return_path_subdomain\": \"mail\",\n  \"subscription_subdomain\": \"preferences\",\n  \"media_subdomain\": \"media\",\n  \"dkim_rotation_interval_days\": 45\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ahasend.com/v2/accounts/{account_id}/domains/{domain}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tracking_subdomain\": \"click\",\n  \"return_path_subdomain\": \"mail\",\n  \"subscription_subdomain\": \"preferences\",\n  \"media_subdomain\": \"media\",\n  \"dkim_rotation_interval_days\": 45\n}"

response = http.request(request)
puts response.read_body

{
  "object": "domain",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "domain": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dns_records": [
    {
      "type": "<string>",
      "host": "<string>",
      "content": "<string>",
      "required": true,
      "propagated": true,
      "label": "<string>"
    }
  ],
  "last_dns_check_at": "2023-11-07T05:31:56Z",
  "dns_valid": true,
  "tracking_subdomain": "<string>",
  "return_path_subdomain": "<string>",
  "subscription_subdomain": "<string>",
  "media_subdomain": "<string>",
  "dkim_rotation_interval_days": 123,
  "dkim_selector": "<string>",
  "rotation_ready": true,
  "dsn_recipient": "<string>"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

The AhaSend API updates DNS domain settings such as custom subdomains and DKIM rotation interval.

Authorizations

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.

Path Parameters

account_id

string<uuid>

required

Account ID

domain

string<hostname>

required

Domain name

Body

application/json

tracking_subdomain

string

Optional custom tracking subdomain. Omit to leave the current value unchanged. Applies to both manual-DNS and managed-DNS domains.

return_path_subdomain

string

Optional custom return-path subdomain. Omit to leave the current value unchanged. Applies to both manual-DNS and managed-DNS domains.

subscription_subdomain

string

Optional custom subscription management subdomain. Omit to leave the current value unchanged. Applies to both manual-DNS and managed-DNS domains.

media_subdomain

string

Optional custom media subdomain. Omit to leave the current value unchanged. Applies to both manual-DNS and managed-DNS domains.

dkim_rotation_interval_days

integer

Optional custom DKIM rotation interval in days. Omit to leave the current value unchanged. Only supported for managed DNS domains on eligible plans.

dkim_selector

string | null

Optional custom DKIM selector for the domain. Omit or send null to leave the current value unchanged; send an empty or whitespace-only string to clear the override and revert to the default selector. The value is trimmed before it is interpreted, so whitespace-only input clears the override just like an empty string.

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. It cannot be changed once the selector locks after DNS verification or while a DKIM key rotation is in progress.

Note: This parameter is only supported on Platform Partner accounts.

Response

Domain updated successfully

object

enum<string>

required

Object type identifier

Available options:

domain

string<uuid>

required

Unique identifier for the domain

created_at

string<date-time>

required

When the domain was created

updated_at

string<date-time>

required

When the domain was last updated

domain

string

required

The domain name

account_id

string<uuid>

required

Account ID this domain belongs to

dns_records

object[]

required

DNS records required for domain verification

Show child attributes

last_dns_check_at

string<date-time> | null

required

When DNS records were last checked

dns_valid

boolean

required

Whether all required DNS records are properly configured

tracking_subdomain

string | null

required

Custom tracking subdomain. Null means the account or product default is used. Applies to both manual-DNS and managed-DNS domains.

return_path_subdomain

string | null

required

Custom return-path subdomain. Null means the account or product default is used. Applies to both manual-DNS and managed-DNS domains.

subscription_subdomain

string | null

required

Custom subscription management subdomain. Null means the account or product default is used. Applies to both manual-DNS and managed-DNS domains.

media_subdomain

string | null

required

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

integer | null

required

Custom DKIM rotation interval in days. Null means the account default is used. Only supported for managed DNS domains.

dkim_selector

string | null

required

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

boolean

required

Whether the standby DKIM slot is ready for rotation.

dsn_recipient

string | null

required

Optional recipient address for delivery status notifications.

Overview

API reference

Webhooks

Message Routing

API v1 (legacy)

Update a Sending Domain via the API

Authorizations

Path Parameters

Body

Response

​Related Guides

Authorizations

Path Parameters

Body

Response

Related Guides