Zur Dokumentation springen
API

Ihr Konto

Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.

Operationen

The account of the person behind the key or the app: which email notifications they get, their profile photo and username, the apps they connected and the invitations waiting for them. These calls act on a person, never on a workspace: an API key acts for the workspace owner, and an app for the person who connected it. Reading needs account:read and every change needs account:write. Neither is ever limited by a role, so an app a member connected reaches the member's own account too.

GET/account/notifications

Read your notification settings

Geltungsbereicheaccount:readLiest

Which kinds of email OpenEmail sends the person, as Account, Notifications shows them, and the workspaces whose notifications are muted on their phone. Account and billing email cannot be turned off.

Requires the account:read scope.

Rückgabe

The notification settings.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.getNotifications()
CLI
openemail account get-notifications
MCP
getNotificationSettings

PUT/account/notifications/email/{category}

Turn a kind of email on or off

Geltungsbereicheaccount:writeÄndert Daten

enabled: false stops OpenEmail sending the person that kind of email, and true starts it again. account and billing cannot be turned off, and asking to is a 422 invalid_parameter on category.

Requires the account:write scope.

Pfadparameter

categorystringErforderlich

The kind of email.

Einer von"account""billing""activity""product"

Request-Body

enabledbooleanErforderlich

True to receive that email, false to stop it.

Rückgabe

The notification settings as they are now.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.setEmailNotification()
CLI
openemail account set-email-notification
MCP
setEmailNotification

PUT/account/notifications/push/{workspaceId}

Mute a workspace on your phone

Geltungsbereicheaccount:writeÄndert Daten

muted: true stops the phone app notifying the person about the mail of one workspace, and false lets it notify them again. It applies to every phone they signed in on. A workspace they cannot open is a 404.

Requires the account:write scope.

Pfadparameter

workspaceIdstringErforderlich

A workspace from GET /workspaces.

Request-Body

mutedbooleanErforderlich

True to mute it, false to let it notify again.

Rückgabe

The notification settings as they are now.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.setPushMuted()
CLI
openemail account set-push-muted
MCP
setWorkspacePushMuted

PUT/account/photo

Set your profile photo

Geltungsbereicheaccount:writeÄndert Daten

Uploads the person's profile photo, replacing any there was, as Account, Profile does. Send the image itself as the body, not JSON, with its type in Content-Type: image/png, image/jpeg, image/webp, image/gif. Up to 5 MB goes in. It is fitted into a 512 pixel square and stored as WebP, and an animated image keeps its first frame.

Requires the account:write scope.

Request-Body

Inhaltstypimage/png, image/jpeg, image/webp, image/gif

binary

Rückgabe

The photo, with its new url.

Fehler

422

invalid_image when the body is not an image of an accepted type, is too large or cannot be read.

502

image_not_stored: the image was read but could not be stored. Try again.

503

image_busy: the image service is saturated. Try again shortly.

Die Fehler, die jede Operation zurückgeben kann400401403404500Fehlerkatalog

Auch verfügbar über

SDK
account.setPhoto()
CLI
openemail account set-photo
MCP
setProfilePhoto

DELETE/account/photo

Remove your profile photo

Geltungsbereicheaccount:writeLöscht

Removes the profile photo and deletes the stored image, so the app shows initials again. Removing it when there is none changes nothing.

Requires the account:write scope.

Rückgabe

Removed, with url null.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.removePhoto()
CLI
openemail account remove-photo
MCP
removeProfilePhoto

GET/account/username

Read your username

Geltungsbereicheaccount:readLiest

The username of the person, whether they chose it or it was made for them, and the free address it gives them. A username is made from their name the first time it is read.

Requires the account:read scope.

Rückgabe

The username.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.getUsername()
CLI
openemail account get-username
MCP
getUsername

PUT/account/username

Choose your username

Geltungsbereicheaccount:writeÄndert Daten

Sets the username for good, and with it the free address. Once chosen it never changes: a second choice is a 409 username_locked. A username another account has is a 409 username_taken, and one that is too short, too long, reserved or not lowercase letters, numbers and single dots is a 422 invalid_parameter on username. Check one first with GET /account/username/availability.

Requires the account:write scope.

Request-Body

usernamestringErforderlich
Bis zu 60 Zeichen

Rückgabe

The username, now chosen.

Fehler

409

username_locked: the username was chosen before and never changes. username_taken: another account has it.

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.setUsername()
CLI
openemail account set-username
MCP
chooseUsername

GET/account/username/availability

Check a username

Geltungsbereicheaccount:readLiest

Whether the person could choose a username, without choosing it. The answer says why when they could not.

Requires the account:read scope.

Query-Parameter

usernamestringErforderlich

The username to check. It is lowercased and its spaces become dots before it is checked, as the app does.

1 bis 60 Zeichen

Rückgabe

The verdict.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.checkUsername()
CLI
openemail account check-username
MCP
checkUsername

GET/account/connected-apps

List your connected apps

Geltungsbereicheaccount:readLiest

Every app the person connected with OAuth, as Account, Connected apps lists them: what each may reach, until when, how many tokens it holds and whether changes are allowed without a code for it right now. current marks the app making the call. Changing what an app may reach is done in the app, never through an app.

Requires the account:read scope.

Rückgabe

The connected apps.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.listConnectedApps()
CLI
openemail account list-connected-apps
MCP
listConnectedApps

DELETE/account/connected-apps/{clientId}

Remove a connected app

Geltungsbereicheaccount:writeLöscht

Deletes every token the app holds and the access the person gave it, so its next call is refused and it has to ask again. Removing the app making the call disconnects it. An app the person never connected is a 404.

Requires the account:write scope.

Pfadparameter

clientIdstringErforderlich

The app's clientId from GET /account/connected-apps.

Rückgabe

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.revokeConnectedApp()
CLI
openemail account revoke-connected-app
MCP
revokeConnectedApp

GET/account/invitations

List your invitations

Geltungsbereicheaccount:readLiest

The invitations to join a workspace waiting for the address the person signs in with, oldest first. Expired, accepted and withdrawn ones are left out.

Requires the account:read scope.

Rückgabe

The invitations.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.listInvitations()
CLI
openemail account list-invitations
MCP
listReceivedInvitations

POST/account/invitations/{invitationId}/accept

Accept an invitation

Geltungsbereicheaccount:writeÄndert Daten

Joins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. activate: true also makes it the workspace the app opens. A workspace that asks for two-factor sign-in is a 403 two_factor_required until the person turns it on, and an invitation that expired, was withdrawn or went to another address is a 422.

Requires the account:write scope.

Pfadparameter

invitationIdstringErforderlich

The invitation id from GET /account/invitations.

Request-Body

activateboolean

Rückgabe

Fehler

403

two_factor_required: the workspace asks everyone in it to sign in with two-factor authentication. mailbox_login: a password sign-in for one address cannot join a workspace.

Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog

Auch verfügbar über

SDK
account.acceptInvitation()
CLI
openemail account accept-invitation
MCP
acceptInvitation

POST/account/invitations/{invitationId}/decline

Decline an invitation

Geltungsbereicheaccount:writeLöscht

Turns the invitation down, so its link stops working, and tells whoever sent it. It cannot be taken back: they have to invite the person again. An invitation they already accepted is a 409 invitation_accepted.

Requires the account:write scope.

Pfadparameter

invitationIdstringErforderlich

The invitation id from GET /account/invitations.

Rückgabe

Declined.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
account.declineInvitation()
CLI
openemail account decline-invitation
MCP
declineInvitation

Objekte

AcceptedInvitationobject

objectstringErforderlich
Einer von"invitation"
idstringErforderlich
acceptedbooleanErforderlich
Einer vontrue
workspaceIdstringErforderlich
workspaceNamestringErforderlich
addressesGrantedintegerErforderlich
Mindestens 0
domainsGrantedintegerErforderlich
Mindestens 0
activatedbooleanErforderlich

Whether the app now opens the workspace, after activate: true.

AccountPhotoobject

objectstringErforderlich
Einer von"account_photo"
urlstringErforderlich
Kann null sein

ConnectedAppobject

objectstringErforderlich
Einer von"connected_app"
clientIdstringErforderlich
namestringErforderlich
Kann null sein
kindstringErforderlich

cli for a sign-in of the command line tool, app for every other app.

Einer von"app""cli"
cliDevicestring
Kann null sein
currentbooleanErforderlich

Whether it is the app making this call.

registeredByAccountboolean
redirectUrisstring[]
connectedAtstring
Kann null seinFormatdate-time
accessUntilstring

When its last token runs out.

Kann null seinFormatdate-time
tokenCountintegerErforderlich
Mindestens 0
statusstringErforderlich
Einer von"active""expired""needs-approval""access-lost"
usablePermissionsinteger

How many of the permissions it was given the person still holds.

Kann null sein
elevatedUntilstring

Until when it may make changes that ask for a verification code without one.

Kann null seinFormatdate-time
grantobject

What the person gave it, or null for an app that has to ask again.

Kann null sein
workspaceIdstringErforderlich

The one workspace the app acts for.

workspaceNamestringErforderlich
Kann null sein
permissionsstring[]Erforderlich
addressAllowliststring[]Erforderlich
Kann null sein
domainAllowliststring[]Erforderlich
Kann null sein
expiresAtstringErforderlich

When the access ends, or null when it lasts until it is removed.

Kann null seinFormatdate-time
updatedAtstringErforderlich
Formatdate-time

DeclinedInvitationobject

objectstringErforderlich
Einer von"invitation"
idstringErforderlich
declinedbooleanErforderlich
Einer vontrue

EmailNotificationSettingobject

categorystringErforderlich
Einer von"account""billing""activity""product"
labelstringErforderlich
descriptionstringErforderlich
requiredbooleanErforderlich

Whether it can never be turned off.

enabledbooleanErforderlich

NotificationSettingsobject

objectstringErforderlich
Einer von"notification_settings"
emailEmailNotificationSetting[]Erforderlich

Every kind of email OpenEmail sends.

mutedWorkspacesstring[]Erforderlich

The workspaces whose notifications are muted on the phone.

ReceivedInvitationobject

objectstringErforderlich
Einer von"invitation"
idstringErforderlich
workspaceIdstringErforderlich
workspaceNamestringErforderlich
roleNamestringErforderlich
inviterNamestring
Kann null sein
addressesintegerErforderlich

How many addresses and whole domains it gives.

Mindestens 0
expiresAtstringErforderlich
Formatdate-time
createdAtstringErforderlich
Formatdate-time

RevokedConnectedAppobject

objectstringErforderlich
Einer von"connected_app"
clientIdstringErforderlich
revokedbooleanErforderlich
Einer vontrue
tokensRevokedintegerErforderlich
Mindestens 0

Usernameobject

objectstringErforderlich
Einer von"username"
usernamestringErforderlich
Kann null sein
chosenbooleanErforderlich

Whether the person chose it. A chosen username never changes.

addressstringErforderlich

The free address the username gives, when this deployment offers one.

Kann null sein

UsernameAvailabilityobject

objectstringErforderlich
Einer von"username_availability"
usernamestringErforderlich

The username as it was checked.

statusstringErforderlich

current when it is the username the person already has.

Einer von"available""current""taken""reserved""invalid""too_short""too_long"
availablebooleanErforderlich
messagestringErforderlich