Ampersand · JSON Structure

Ampersand Api Patch Api Key Request Structure

PatchApiKeyRequest schema from Ampersand API

Type: object Properties: 2 Required: 2
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

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

Properties

updateMask apiKey

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/ampersand/refs/heads/main/json-structure/ampersand-api-patch-api-key-request-structure.json",
  "name": "PatchApiKeyRequest",
  "description": "PatchApiKeyRequest schema from Ampersand API",
  "type": "object",
  "properties": {
    "updateMask": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of field paths specifying which fields to update. Allowed values include:\n- active\n- label\n- scopes\n",
      "example": [
        "active",
        "label"
      ]
    },
    "apiKey": {
      "type": "object",
      "properties": {
        "label": {
          "type": "string",
          "description": "A short name for the API key.",
          "example": "MailMonkey API Key"
        },
        "active": {
          "type": "boolean",
          "description": "Whether the API key is active.",
          "example": true
        },
        "scopes": {
          "$ref": "#/components/schemas/ApiKeyScopes"
        }
      }
    }
  },
  "required": [
    "updateMask",
    "apiKey"
  ]
}