Saltar para a documentação
API

A sua conta

Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.

Operações

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

Âmbitosaccount:readLê

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.

Devolve

The notification settings.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

PUT/account/notifications/email/{category}

Turn a kind of email on or off

Âmbitosaccount:writeAltera dados

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.

Parâmetros de caminho

categorystringObrigatório

The kind of email.

Um de"account""billing""activity""product"

Corpo do pedido

enabledbooleanObrigatório

True to receive that email, false to stop it.

Devolve

The notification settings as they are now.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

PUT/account/notifications/push/{workspaceId}

Mute a workspace on your phone

Âmbitosaccount:writeAltera dados

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.

Parâmetros de caminho

workspaceIdstringObrigatório

A workspace from GET /workspaces.

Corpo do pedido

mutedbooleanObrigatório

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

Devolve

The notification settings as they are now.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

PUT/account/photo

Set your profile photo

Âmbitosaccount:writeAltera dados

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.

Corpo do pedido

Tipo de conteúdoimage/png, image/jpeg, image/webp, image/gif

binary

Devolve

The photo, with its new url.

Erros

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.

Os erros que qualquer operação pode devolver400401403404500Catálogo de erros

Também disponível em

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

GET/account/username

Read your username

Âmbitosaccount:readLê

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.

Devolve

The username.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

PUT/account/username

Choose your username

Âmbitosaccount:writeAltera dados

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.

Corpo do pedido

usernamestringObrigatório
Até 60 caracteres

Devolve

The username, now chosen.

Erros

409

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

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

GET/account/username/availability

Check a username

Âmbitosaccount:readLê

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

Requires the account:read scope.

Parâmetros de consulta

usernamestringObrigatório

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

De 1 a 60 caracteres

Devolve

The verdict.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

GET/account/connected-apps

List your connected apps

Âmbitosaccount:readLê

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.

Devolve

The connected apps.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

DELETE/account/connected-apps/{clientId}

Remove a connected app

Âmbitosaccount:writeElimina

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.

Parâmetros de caminho

clientIdstringObrigatório

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

Devolve

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

POST/account/invitations/{invitationId}/accept

Accept an invitation

Âmbitosaccount:writeAltera dados

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.

Parâmetros de caminho

invitationIdstringObrigatório

The invitation id from GET /account/invitations.

Corpo do pedido

activateboolean

Devolve

Erros

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.

Os erros que qualquer operação pode devolver400401404422500Catálogo de erros

Também disponível em

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

POST/account/invitations/{invitationId}/decline

Decline an invitation

Âmbitosaccount:writeElimina

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.

Parâmetros de caminho

invitationIdstringObrigatório

The invitation id from GET /account/invitations.

Devolve

Declined.

Erros

Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros

Também disponível em

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

Objetos

AcceptedInvitationobject

objectstringObrigatório
Um de"invitation"
idstringObrigatório
acceptedbooleanObrigatório
Um detrue
workspaceIdstringObrigatório
workspaceNamestringObrigatório
addressesGrantedintegerObrigatório
Pelo menos 0
domainsGrantedintegerObrigatório
Pelo menos 0
activatedbooleanObrigatório

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

AccountPhotoobject

objectstringObrigatório
Um de"account_photo"
urlstringObrigatório
Pode ser null

ConnectedAppobject

objectstringObrigatório
Um de"connected_app"
clientIdstringObrigatório
namestringObrigatório
Pode ser null
kindstringObrigatório

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

Um de"app""cli"
cliDevicestring
Pode ser null
currentbooleanObrigatório

Whether it is the app making this call.

registeredByAccountboolean
redirectUrisstring[]
connectedAtstring
Pode ser nullFormatodate-time
accessUntilstring

When its last token runs out.

Pode ser nullFormatodate-time
tokenCountintegerObrigatório
Pelo menos 0
statusstringObrigatório
Um de"active""expired""needs-approval""access-lost"
usablePermissionsinteger

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

Pode ser null
elevatedUntilstring

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

Pode ser nullFormatodate-time
grantobject

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

Pode ser null
workspaceIdstringObrigatório

The one workspace the app acts for.

workspaceNamestringObrigatório
Pode ser null
permissionsstring[]Obrigatório
addressAllowliststring[]Obrigatório
Pode ser null
domainAllowliststring[]Obrigatório
Pode ser null
expiresAtstringObrigatório

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

Pode ser nullFormatodate-time
updatedAtstringObrigatório
Formatodate-time

DeclinedInvitationobject

objectstringObrigatório
Um de"invitation"
idstringObrigatório
declinedbooleanObrigatório
Um detrue

EmailNotificationSettingobject

categorystringObrigatório
Um de"account""billing""activity""product"
labelstringObrigatório
descriptionstringObrigatório
requiredbooleanObrigatório

Whether it can never be turned off.

enabledbooleanObrigatório

NotificationSettingsobject

objectstringObrigatório
Um de"notification_settings"
emailEmailNotificationSetting[]Obrigatório

Every kind of email OpenEmail sends.

mutedWorkspacesstring[]Obrigatório

The workspaces whose notifications are muted on the phone.

ReceivedInvitationobject

objectstringObrigatório
Um de"invitation"
idstringObrigatório
workspaceIdstringObrigatório
workspaceNamestringObrigatório
roleNamestringObrigatório
inviterNamestring
Pode ser null
addressesintegerObrigatório

How many addresses and whole domains it gives.

Pelo menos 0
expiresAtstringObrigatório
Formatodate-time
createdAtstringObrigatório
Formatodate-time

RevokedConnectedAppobject

objectstringObrigatório
Um de"connected_app"
clientIdstringObrigatório
revokedbooleanObrigatório
Um detrue
tokensRevokedintegerObrigatório
Pelo menos 0

Usernameobject

objectstringObrigatório
Um de"username"
usernamestringObrigatório
Pode ser null
chosenbooleanObrigatório

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

addressstringObrigatório

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

Pode ser null

UsernameAvailabilityobject

objectstringObrigatório
Um de"username_availability"
usernamestringObrigatório

The username as it was checked.

statusstringObrigatório

current when it is the username the person already has.

Um de"available""current""taken""reserved""invalid""too_short""too_long"
availablebooleanObrigatório
messagestringObrigatório