Skip to main content
PUT
AhaSend Go SDK

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

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

last_used_at
string<date-time> | null
required

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

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.