Update API Key

PATCH

/v0/inboxes/:inbox_id/api-keys/:api_key_id

PATCH

/v0/inboxes/:inbox_id/api-keys/:api_key_id

from agentmail import AgentMail
client = AgentMail(
    api_key="YOUR_TOKEN_HERE",
)
client.inboxes.api_keys.update(
    inbox_id="inbox_id",
    api_key_id="api_key_id",
)

{
  "type": "bearer",
  "api_key_id": "api_key_id",
  "prefix": "prefix",
  "name": "name",
  "pod_id": "pod_id",
  "inbox_id": "inbox_id",
  "used_at": "2024-01-15T09:30:00Z",
  "permissions": {
    "inbox_read": true,
    "inbox_create": true,
    "inbox_update": true,
    "inbox_delete": true,
    "message_read": true,
    "message_send": true,
    "message_update": true,
    "message_delete": true,
    "label_spam_read": true,
    "label_blocked_read": true,
    "label_unauthenticated_read": true,
    "label_trash_read": true,
    "draft_read": true,
    "draft_create": true,
    "draft_update": true,
    "draft_delete": true,
    "draft_send": true,
    "webhook_read": true,
    "webhook_create": true,
    "webhook_update": true,
    "webhook_delete": true,
    "domain_read": true,
    "domain_create": true,
    "domain_update": true,
    "domain_delete": true,
    "list_entry_read": true,
    "list_entry_create": true,
    "list_entry_delete": true,
    "metrics_read": true,
    "api_key_read": true,
    "api_key_create": true,
    "api_key_update": true,
    "api_key_delete": true,
    "provider_connect": true,
    "provider_share_owner": true,
    "pod_read": true,
    "pod_create": true,
    "pod_delete": true
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-15T09:30:00Z"
}

CLI:

agentmail inboxes api-keys update --inbox-id <inbox_id> --api-key-id <api_key_id> --name "Renamed"

**CLI:** ```bash agentmail inboxes api-keys update --inbox-id <inbox_id> --api-key-id <api_key_id> --name "Renamed" ```

Authentication

AuthorizationBearer

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

Path parameters

inbox_idstringRequired

The ID of the inbox.

api_key_idstringRequired

ID of api key.

Request

This endpoint expects an object.

namestringOptional

Name of api key.

permissionsobjectOptional

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

Response

This endpoint returns an object.

Bearer API Keyobject

Public Key Credentialobject

Errors

400

Validation Error

404

Not Found Error