No tracking runs without JavaScript.

Skip to content
Sendtier Docs
Dashboard

Rename an active API key

Requires a full-scope key. Only the name changes; the secret and permissions stay the same. Unknown or revoked keys return not_found.

PATCH/api-keys/{key_id}

Request body

ParameterDescription
namerequired
string

Maximum length: 64.

Full request schema and constraints

Request Body

application/json
  1. body
name*string
Length1 <= length <= 64

Path parameters

ParameterDescription
key_idrequired
string
Full parameter schemas and constraints

Path Parameters

key_id*string

Authorization

headerAuthorizationBearer <token>

API key: st_live_... or st_test_...

Response Body

Updated API key metadata without the secret.

application/json
  1. response
id*string
name*string
mode*string
Value in"live""test"
scope*string
Value in"full""sending""domain""read_only"
prefix*string

Stored lookup prefix, not the full secret.

created_at*string
Formatdate-time
last_used_at?string
Formatdate-time