Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
ApiKeys

Update an API key

Updates an API key's settings and returns the updated key. A field left out keeps its value.

PATCH
/v1/api-keys/{id}

Updates an API key's settings and returns the updated key. A field left out keeps its value.

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

id*string
Match^key_[0-9a-hjkmnp-tv-z]{16,24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|null
description?string|null
mailboxes?|

Changes the mailbox send mode of a key that holds mailbox access. Only a person can change it; the change applies to the key's next request.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/api-keys/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "key": "string",  "start": "string",  "description": "string",  "createdAt": "string",  "expiresAt": "string",  "lastUsedAt": "string",  "isActive": true,  "access": {    "mode": "full"  },  "owner": {    "id": "string",    "name": "string",    "email": "string"  }}

Related documentation

Rotate an API key

Issues a replacement with the same owner, name, and access, then deactivates the existing key. Returns the new key, including the plaintext secret.

Create an organization

Creates a new organization under the current billing account and returns it. Use this endpoint to create an organization through the Samva email API.