Skip to main content

PermissionScope

Permission scope for an API key. Base scopes grant access to all domains. Per-domain restriction is supported for sending, emails:read, and domains:manage using the format {scope}:domain:{domain_name}, for example sending:domain:acme.com, restricts sending to acme.com only. Multiple domain-scoped permissions can be combined.

stringPermissionScope

Permission scope for an API key. Base scopes grant access to all domains. Per-domain restriction is supported for sending, emails:read, and domains:manage using the format {scope}:domain:{domain_name}, for example sending:domain:acme.com, restricts sending to acme.com only. Multiple domain-scoped permissions can be combined.

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

PermissionScope
"sending"