AhaSend · Schema

UpdateAPIKeyRequest

UpdateAPIKeyRequest schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
label string Human-readable label for the API key
scopes array Array of scope strings to grant to this API key
View JSON Schema on GitHub

JSON Schema

openapi-v2-update-api-key-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-schema/openapi-v2-update-api-key-request-schema.json",
  "title": "UpdateAPIKeyRequest",
  "description": "UpdateAPIKeyRequest schema from AhaSend API",
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "maxLength": 255,
      "description": "Human-readable label for the API key",
      "example": "example_value"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "Array of scope strings to grant to this API key",
      "example": [
        "example_value"
      ]
    }
  },
  "example": {
    "label": "Updated API Key",
    "scopes": [
      "messages:send:example.com",
      "domains:read"
    ]
  }
}