Skip to main content
PUT
/
v2
/
accounts
/
{account_id}
/
api-keys
/
{key_id}
AhaSend Go SDK
package main

import (
  "context"
  "fmt"
  "log"

  "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 an existing API key
  response, httpResp, err := client.APIKeysAPI.UpdateAPIKey(
    ctx,
    accountID,
    uuid.MustParse("c5a32c40-b351-439f-8230-779daed3e42c"),
    requests.UpdateAPIKeyRequest{
      Label: ahasend.String("My API Key"),
      Scopes: &[]string{
        "messages:read:all",
        "domains:read",
      },
      // Replace the allowed source IPs. Use &[]string{} to clear the
      // list (usable from any IP), or omit the field to leave the
      // current list unchanged.
      IPAllowList: &[]string{"203.0.113.0/24"},
    },
  )
  if err != nil {
    log.Fatalf("Error updating API key: %v", err)
  }

  // Check response
  if httpResp.StatusCode == 200 {
    fmt.Printf("✅ Status: %d\n", httpResp.StatusCode)
    if response != nil {
      fmt.Printf("Updated API key: %#v\n", response)
    }
  } else {
    fmt.Printf("❌ Unexpected status code: %d\n", httpResp.StatusCode)
  }
}
curl --request PUT \
  --url https://api.ahasend.com/v2/accounts/{account_id}/api-keys/{key_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "Updated API Key",
  "scopes": [
    "messages:send:{example.com}",
    "domains:read"
  ],
  "ip_allow_list": [
    "203.0.113.0/24"
  ]
}
'
import requests

url = "https://api.ahasend.com/v2/accounts/{account_id}/api-keys/{key_id}"

payload = {
    "label": "Updated API Key",
    "scopes": ["messages:send:{example.com}", "domains:read"],
    "ip_allow_list": ["203.0.113.0/24"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: 'Updated API Key',
    scopes: ['messages:send:{example.com}', 'domains:read'],
    ip_allow_list: ['203.0.113.0/24']
  })
};

fetch('https://api.ahasend.com/v2/accounts/{account_id}/api-keys/{key_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ahasend.com/v2/accounts/{account_id}/api-keys/{key_id}",
  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([
    'label' => 'Updated API Key',
    'scopes' => [
        'messages:send:{example.com}',
        'domains:read'
    ],
    'ip_allow_list' => [
        '203.0.113.0/24'
    ]
  ]),
  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}/api-keys/{key_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"Updated API Key\",\n  \"scopes\": [\n    \"messages:send:{example.com}\",\n    \"domains:read\"\n  ],\n  \"ip_allow_list\": [\n    \"203.0.113.0/24\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.ahasend.com/v2/accounts/{account_id}/api-keys/{key_id}")

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  \"label\": \"Updated API Key\",\n  \"scopes\": [\n    \"messages:send:{example.com}\",\n    \"domains:read\"\n  ],\n  \"ip_allow_list\": [\n    \"203.0.113.0/24\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "object": "api_key",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "public_key": "<string>",
  "scopes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "api_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scope": "<string>",
      "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "ip_allow_list": [
    "<string>"
  ],
  "last_used_at": "2023-11-07T05:31:56Z",
  "secret_key": "<string>"
}
{
  "message": "Error message"
}
{
  "message": "Error message"
}
{
  "message": "Error message"
}
{
  "message": "Error message"
}
{
  "message": "Error message"
}
{
  "message": "Error message"
}

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

account_id
string<uuid>
required

Account ID

key_id
string<uuid>
required

API Key ID

Body

application/json

At least one non-null field must be provided, and at least one provided value must differ from the current value. Omitted or null fields are left unchanged.

label
string
required

Human-readable label for the API key. Omit to keep the existing label.

Required string length: 1 - 255
scopes
string[] | null

Array of scope strings to grant to this API key

Minimum array length: 1
ip_allow_list
string[] | null

Replacement list of allowed source IPs (CIDR blocks or bare IPv4/IPv6 addresses; canonicalized and de-duplicated, at most 100 entries, allow-all prefixes 0.0.0.0/0 and ::/0 rejected). Omit the field or send null to leave the existing list unchanged; send an empty array to clear it (key usable from any IP); send a non-empty array to replace it.

Response

API key updated successfully

object
enum<string>
required

Object type identifier

Available options:
api_key
id
string<uuid>
required

Unique identifier for the API key

created_at
string<date-time>
required

When the API key was created

updated_at
string<date-time>
required

When the API key was last updated

account_id
string<uuid>
required

Account ID this API key belongs to

label
string
required

Human-readable label for the API key

public_key
string
required

Public portion of the API key

scopes
object[]
required

Scopes granted to this API key

ip_allow_list
string[]
required

Source IPs allowed to authenticate with this API key, as canonical CIDR blocks (a bare address is stored as a /32 for IPv4 or /128 for IPv6). Always present; an empty array means the key may be used from any source IP. When non-empty, an 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.

last_used_at
string<date-time> | null

When the API key was last used (updates every 5-10 minutes)

secret_key
string

Secret key. Only returned when an API key is created, including exact idempotent replays of create requests within the 5-minute secret-bearing replay window. Store it immediately; list, get, update, and delete responses omit it.