AhaSend · JSON Structure

Openapi V2 Create Api Key Request Structure

CreateAPIKeyRequest schema from AhaSend API

Type: object Properties: 2 Required: 2
EmailTransactional EmailDeveloper ToolsSMTPWebhooks

CreateAPIKeyRequest is a JSON Structure definition published by AhaSend, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

label scopes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-structure/openapi-v2-create-api-key-request-structure.json",
  "name": "CreateAPIKeyRequest",
  "description": "CreateAPIKeyRequest 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"
      ]
    }
  },
  "required": [
    "label",
    "scopes"
  ],
  "example": {
    "label": "Production API Key",
    "scopes": [
      "messages:send:all",
      "domains:read"
    ]
  }
}