API · API keys

Update API key

Update an API key (requires full access).

PATCH/api-keys/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Resource identifier for id.
`name` body · required	`string` 1–50 characters	See operation behavior.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X PATCH "$OPENSEND_BASE_URL/api-keys/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"Production"}'

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "api_key",
  "id": "YOUR_ID"
}

Behavior and errors

Updating a name does not rotate the key or change its permissions.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.