OpenEmailOpenEmail
  • Pricing
Sign in
Skip to the documentation
Get startedKnowledge baseMCP serverAPISDK
Getting started
  • Quickstart
  • Authentication
  • Scopes
  • Errors
  • Idempotency
Emails
  • Send an emailPOST
  • Send a batchPOST
  • Preview a translationPOST
  • Schedule and cancel
  • List and retrieve
  • Open and click tracking
  • LanguagesGET
Mailbox
  • Threads
Roles & access
Disposable inboxes
  • List pooled domainsGET
Reference
  • OpenAPI
  • Not built yet
API

Roles & access

What a person or a key may DO, and which addresses they may do it to. Two axes, two resources, and both have to agree before a message goes out.

In this section

List rolesEvery role, built-ins first, and who holds each.Create a roleA name and a list of permissions.Retrieve a roleOne role in full.Update a role`permissions` replaces the whole list.Delete a roleAny role but the owner, once you say where its holders go.List permissionsThe vocabulary, and which entries a key may hold.List membersEverybody here, with their role and their addresses.Add a memberBy email, with a role, and optionally addresses.Retrieve a memberOne person, by account id.Change a member’s roleThe role, and nothing else.Remove a memberThe role and every grant, together.Grant and revoke an addressThe second axis, one address at a time.ScopesHow a role caps a key: scopes ∩ permissions.
PreviousUpdate a domainNextList roles