Update API Key

Updates an existing API key’s label and scopes

PUT /v2/accounts/{account_id}/api-keys/{key_id}

AhaSend Go SDK

Go

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)
  }
}

200

{
  "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>"
}

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

Option 1

Option 2

Option 3

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

200

application/json

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

Show child attributes

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.