Delete API Key

Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->

PATCH https://api.aisa.one/apis/v1/agentmail/api-keys/{api_key_id}

Delete API Key

cURL

curl --request PATCH \
  --url https://api.aisa.one/apis/v1/agentmail/api-keys/{api_key_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissions": {
    "account_update": true,
    "api_key_create": true,
    "api_key_delete": true,
    "api_key_read": true,
    "api_key_update": true,
    "app_connect": true,
    "app_share_owner": true,
    "calendar_event_create": true,
    "calendar_event_delete": true,
    "calendar_event_read": true,
    "calendar_event_update": true,
    "calendar_read": true,
    "calendar_update": true,
    "domain_create": true,
    "domain_delete": true,
    "domain_read": true,
    "domain_update": true,
    "draft_create": true,
    "draft_delete": true,
    "draft_read": true,
    "draft_send": true,
    "draft_update": true,
    "inbox_create": true,
    "inbox_delete": true,
    "inbox_read": true,
    "inbox_update": true,
    "label_blocked_read": true,
    "label_spam_read": true,
    "label_trash_read": true,
    "label_unauthenticated_read": true,
    "list_entry_create": true,
    "list_entry_delete": true,
    "list_entry_read": true,
    "message_delete": true,
    "message_read": true,
    "message_reply": true,
    "message_send": true,
    "message_update": true,
    "metrics_read": true,
    "pod_create": true,
    "pod_delete": true,
    "pod_read": true,
    "pod_update": true,
    "webhook_create": true,
    "webhook_delete": true,
    "webhook_read": true,
    "webhook_update": true
  }
}
'

200

{
  "api_key_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "prefix": "<string>",
  "type": "bearer",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "inbox_id": "<string>",
  "permissions": {
    "account_update": true,
    "api_key_create": true,
    "api_key_delete": true,
    "api_key_read": true,
    "api_key_update": true,
    "app_connect": true,
    "app_share_owner": true,
    "calendar_event_create": true,
    "calendar_event_delete": true,
    "calendar_event_read": true,
    "calendar_event_update": true,
    "calendar_read": true,
    "calendar_update": true,
    "domain_create": true,
    "domain_delete": true,
    "domain_read": true,
    "domain_update": true,
    "draft_create": true,
    "draft_delete": true,
    "draft_read": true,
    "draft_send": true,
    "draft_update": true,
    "inbox_create": true,
    "inbox_delete": true,
    "inbox_read": true,
    "inbox_update": true,
    "label_blocked_read": true,
    "label_spam_read": true,
    "label_trash_read": true,
    "label_unauthenticated_read": true,
    "list_entry_create": true,
    "list_entry_delete": true,
    "list_entry_read": true,
    "message_delete": true,
    "message_read": true,
    "message_reply": true,
    "message_send": true,
    "message_update": true,
    "metrics_read": true,
    "pod_create": true,
    "pod_delete": true,
    "pod_read": true,
    "pod_update": true,
    "webhook_create": true,
    "webhook_delete": true,
    "webhook_read": true,
    "webhook_update": true
  },
  "pod_id": "<string>",
  "used_at": "2023-11-07T05:31:56Z"
}

Request contract

• Method and path: PATCH /apis/v1/agentmail/api-keys/{api_key_id}
• Availability: enabled
• Request URL template: https://api.aisa.one/apis/v1/agentmail/api-keys/&#123;api&#95;key&#95;id&#125;
• api_key_id: path; required
• Runtime facts: 18a04e28941fae19674c11246b677373368b6bd927b7c146220cec1f168f4639

Complete OpenAPI definition

Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "patch_any_agentmail_apis_v1_agentmail_api_keys_ap_294dbb",
  "method": "PATCH",
  "path": "/apis/v1/agentmail/api-keys/{api_key_id}",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "in": "path",
      "name": "api_key_id",
      "required": true,
      "schema": {
        "description": "ID of api key.",
        "title": "ApiKeyId",
        "type": "string"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "description": "Rename a credential or change its permissions. Key material, type,\nscope, and expiry are immutable.",
          "properties": {
            "name": {
              "description": "Name of api key.",
              "title": "Name",
              "type": "string"
            },
            "permissions": {
              "description": "Granular permissions for the API key. When ommitted all permissions are granted. Otherwise, only permissions set to true are granted.",
              "properties": {
                "account_update": {
                  "description": "Update accounts: disable or re-enable an inbox's sign-in at an app. Reading accounts\nneeds only `inbox_read`.",
                  "type": "boolean"
                },
                "api_key_create": {
                  "description": "Create API keys.",
                  "type": "boolean"
                },
                "api_key_delete": {
                  "description": "Delete API keys.",
                  "type": "boolean"
                },
                "api_key_read": {
                  "description": "Read API keys.",
                  "type": "boolean"
                },
                "api_key_update": {
                  "description": "Update API keys.",
                  "type": "boolean"
                },
                "app_connect": {
                  "description": "Sign in to apps as an inbox: connect an app, authorize an inbox, and mint the\nsign-in keys. Omitted on a new bearer key means false, whatever else the key holds.",
                  "type": "boolean"
                },
                "app_share_owner": {
                  "description": "Share the organization owner's name and email with apps at sign-in. One permission\nfor both values.",
                  "type": "boolean"
                },
                "calendar_event_create": {
                  "description": "Create calendar events.",
                  "type": "boolean"
                },
                "calendar_event_delete": {
                  "description": "Delete calendar events.",
                  "type": "boolean"
                },
                "calendar_event_read": {
                  "description": "Read calendar events, and receive `calendar.event.*` webhook and WebSocket events.",
                  "type": "boolean"
                },
                "calendar_event_update": {
                  "description": "Update calendar events and respond to invitations.",
                  "type": "boolean"
                },
                "calendar_read": {
                  "description": "Read inbox calendar settings.",
                  "type": "boolean"
                },
                "calendar_update": {
                  "description": "Update inbox calendar settings.",
                  "type": "boolean"
                },
                "domain_create": {
                  "description": "Create domains.",
                  "type": "boolean"
                },
                "domain_delete": {
                  "description": "Delete domains.",
                  "type": "boolean"
                },
                "domain_read": {
                  "description": "Read domain details.",
                  "type": "boolean"
                },
                "domain_update": {
                  "description": "Update domains.",
                  "type": "boolean"
                },
                "draft_create": {
                  "description": "Create drafts.",
                  "type": "boolean"
                },
                "draft_delete": {
                  "description": "Delete drafts.",
                  "type": "boolean"
                },
                "draft_read": {
                  "description": "Read drafts.",
                  "type": "boolean"
                },
                "draft_send": {
                  "description": "Send drafts.",
                  "type": "boolean"
                },
                "draft_update": {
                  "description": "Update drafts.",
                  "type": "boolean"
                },
                "inbox_create": {
                  "description": "Create new inboxes.",
                  "type": "boolean"
                },
                "inbox_delete": {
                  "description": "Delete inboxes.",
                  "type": "boolean"
                },
                "inbox_read": {
                  "description": "Read inbox details.",
                  "type": "boolean"
                },
                "inbox_update": {
                  "description": "Update inbox settings.",
                  "type": "boolean"
                },
                "label_blocked_read": {
                  "description": "Access messages labeled blocked.",
                  "type": "boolean"
                },
                "label_spam_read": {
                  "description": "Access messages labeled spam.",
                  "type": "boolean"
                },
                "label_trash_read": {
                  "description": "Access messages labeled trash.",
                  "type": "boolean"
                },
                "label_unauthenticated_read": {
                  "description": "Access messages labeled unauthenticated.",
                  "type": "boolean"
                },
                "list_entry_create": {
                  "description": "Create list entries.",
                  "type": "boolean"
                },
                "list_entry_delete": {
                  "description": "Delete list entries.",
                  "type": "boolean"
                },
                "list_entry_read": {
                  "description": "Read list entries.",
                  "type": "boolean"
                },
                "message_delete": {
                  "description": "Delete messages. Also required to delete threads.",
                  "type": "boolean"
                },
                "message_read": {
                  "description": "Read messages. Also required to read threads.",
                  "type": "boolean"
                },
                "message_reply": {
                  "description": "Reply and reply-all when the request is signed with a registered public key. Bearer keys reply with `message_send`.",
                  "type": "boolean"
                },
                "message_send": {
                  "description": "Send messages.",
                  "type": "boolean"
                },
                "message_update": {
                  "description": "Update message labels. Also required to update threads.",
                  "type": "boolean"
                },
                "metrics_read": {
                  "description": "Read metrics.",
                  "type": "boolean"
                },
                "pod_create": {
                  "description": "Create pods.",
                  "type": "boolean"
                },
                "pod_delete": {
                  "description": "Delete pods.",
                  "type": "boolean"
                },
                "pod_read": {
                  "description": "Read pods.",
                  "type": "boolean"
                },
                "pod_update": {
                  "description": "Update pods.",
                  "type": "boolean"
                },
                "webhook_create": {
                  "description": "Create webhooks.",
                  "type": "boolean"
                },
                "webhook_delete": {
                  "description": "Delete webhooks.",
                  "type": "boolean"
                },
                "webhook_read": {
                  "description": "Read webhook configurations.",
                  "type": "boolean"
                },
                "webhook_update": {
                  "description": "Update webhooks.",
                  "type": "boolean"
                }
              },
              "title": "ApiKeyPermissions",
              "type": "object"
            }
          },
          "title": "UpdateApiKeyRequest",
          "type": "object"
        }
      }
    }
  },
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "explicit_zero",
    "customer_pricing": "fixed_success",
    "default_request_estimate_usd": 0.012,
    "estimate_source": "profile_seed",
    "evidence_source": "request_snapshot"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ.

Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

• Default request reference estimate (USD): 0.012
• Cost contract: explicit_zero
• Settlement evidence source: request_snapshot

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

api_key_id · string · required

ID of api key.

Body

application/json

Rename a credential or change its permissions. Key material, type, scope, and expiry are immutable.

name · string

Name of api key.

permissions · ApiKeyPermissions · object

Granular permissions for the API key. When ommitted all permissions are granted. Otherwise, only permissions set to true are granted.

Show child attributes

Response

200

application/json

Response with status 200

BearerApiKey

PublicKeyCredential

An API key presented as a bearer token in the Authorization header.

api_key_id · string · required

ID of api key.

created_at · string<date-time> · required

Time at which api key was created.

name · string · required

Name of api key.

prefix · string · required

Prefix of api key.

type · enum<string> · required

Available options: bearer

updated_at · string<date-time> · required

Time at which api key was last updated.

expires_at · string<date-time>

Time at which api key expires. Omitted when it does not expire.

inbox_id · string

Inbox ID the api key is scoped to. If set, the key can only access resources within this inbox.

permissions · ApiKeyPermissions · object

Granular permissions for the API key. When ommitted all permissions are granted. Otherwise, only permissions set to true are granted.

Show child attributes

pod_id · string

Pod ID the api key is scoped to. If set, the key can only access resources within this pod.

used_at · string<date-time>

Time at which api key was last used.