APIKeyCreateRequest

namestringrequired

Human-readable name for this key.

environmentstring

Key environment.

Possible values: [live, test]

Default value: live

expires_atstring<date-time>required

When the key should expire.

whitelist_ipsstring[]

Allowed IP addresses in CIDR notation.

permissionsPermissionScope[]

Permission scopes. Defaults to ["*"] (full access) if omitted.

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, *]

APIKeyCreateRequest

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