S
Samva
S
Samva
DashboardAPISamva DocumentationQuickstart GuideAuthentication

API Reference

Email Management

Conversation Management

Configuration

Create API KeyGet API KeyGet API Key ActivityGet API Key StatsList API KeysRemove API KeyRotate API KeyUpdate API Key

Analytics & Operations

OpenAPI Specification
API ReferenceApiKeys

Update API Key

PATCH
/api-keys/:id

Authorization

apiKey
X-API-Key<token>

API key for authentication

In: header

Request Body

application/json

id*string

API key ID

Formatuuid
name?string
Length1 <= length <= 100
description?string

Response Body

application/json

curl -X PATCH "https://samva.app/api/v1/api-keys/:id" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'
{
  "id": "string",
  "name": "string",
  "key": "string",
  "description": "string",
  "organizationId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "lastUsedAt": "2019-08-24T14:15:22Z",
  "isActive": true,
  "permissions": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "roleName": "string"
}

Rotate API Key

Previous Page

Export Analytics Data

Next Page

curl -X PATCH "https://samva.app/api/v1/api-keys/:id" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }'