Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
ApiKeys

Update an API key

Updates the name or description of an API key and returns the updated key. Use this endpoint to update an API key through the Samva email API.

PATCH
/v1/api-keys/{id}

Updates the name or description of an API key and returns the updated key.

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

Response Body

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,  "permissions": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "roleName": "string"}

Rotate an API key

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

Get a log entry

Returns one log entry by message id, including the message content, its status history, and the sanitized API request Samva recorded when it accepted the send.