AhaSend · Schema

APIKeyScope

APIKeyScope schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name	Type	Description
id	string	Unique identifier for the scope
created_at	string	When the scope was created
updated_at	string	When the scope was last updated
api_key_id	string	ID of the API key this scope belongs to
scope	string	The scope string
domain_id	string	Domain ID for domain-specific scopes

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-schema/openapi-v2-api-key-scope-schema.json",
  "title": "APIKeyScope",
  "description": "APIKeyScope schema from AhaSend API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the scope",
      "example": "500123"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the scope was created",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the scope was last updated",
      "example": "2025-03-15T14:30:00Z"
    },
    "api_key_id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the API key this scope belongs to",
      "example": "500123"
    },
    "scope": {
      "type": "string",
      "description": "The scope string",
      "example": "example_value"
    },
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "description": "Domain ID for domain-specific scopes",
      "example": "500123"
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "api_key_id",
    "scope"
  ]
}