APIKeyCreateResponse

idstringrequired

namestringrequired

environmentstringrequired

Possible values: [live, test]

permissionsPermissionScope[]required

Possible values: [sending, emails:read, domains:manage, contacts:manage, webhooks:manage, analytics:read, api-keys:manage, suppressions:read, suppressions:manage, templates:read, templates:manage, inbound:read, inbound:manage, broadcasts:read, broadcasts:manage, broadcasts:send, *]

tokenstringrequired

The full API key token. It is shown only once, so store it securely.

token_hintstringrequired

Last 8 characters for future identification.

whitelist_ipsstring[]

created_atstring<date-time>required

expires_atstring<date-time>nullable

APIKeyCreateResponse

{
  "id": "string",
  "name": "string",
  "environment": "live",
  "permissions": [
    "sending"
  ],
  "token": "string",
  "token_hint": "string",
  "whitelist_ips": [
    "string"
  ],
  "created_at": "2024-07-29T15:51:28.071Z",
  "expires_at": "2024-07-29T15:51:28.071Z"
}