Create API Key | AgentMail

from agentmail import AgentMail
client = AgentMail(
    api_key="YOUR_TOKEN_HERE",
)
client.api_keys.create(
    name="name",
)

{
  "api_key_id": "api_key_id",
  "api_key": "api_key",
  "prefix": "prefix",
  "name": "name",
  "created_at": "2024-01-15T09:30:00Z",
  "pod_id": "pod_id",
  "inbox_id": "inbox_id",
  "permissions": {
    "inbox_read": true,
    "inbox_create": true,
    "inbox_update": true,
    "inbox_delete": true,
    "thread_read": true,
    "thread_delete": true,
    "message_read": true,
    "message_send": true,
    "message_update": true,
    "label_spam_read": true,
    "label_blocked_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_delete": true,
    "pod_read": true,
    "pod_create": true,
    "pod_delete": true
  }
}

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

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.

api_key_idstring

ID of api key.

api_keystring

API key.

prefixstring

Prefix of api key.

namestring

Name of api key.

created_atdatetime

Time at which api key was created.

pod_idstring

Pod ID the api key is scoped to.

inbox_idstring

Inbox ID the api key is scoped to.

permissionsobject

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

Errors

400

Validation Error