Ir a la documentación
API

Tu cuenta

Cada operación de este grupo: lo que acepta, lo que devuelve y los errores con los que puede responder.

Operaciones

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

Alcancesaccount:readLee

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.

Devuelve

The notification settings.

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

PUT/account/notifications/email/{category}

Turn a kind of email on or off

Alcancesaccount:writeCambia datos

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 ruta

categorystringObligatorio

The kind of email.

Uno de"account""billing""activity""product"

Cuerpo de la petición

enabledbooleanObligatorio

True to receive that email, false to stop it.

Devuelve

The notification settings as they are now.

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

PUT/account/notifications/push/{workspaceId}

Mute a workspace on your phone

Alcancesaccount:writeCambia datos

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 ruta

workspaceIdstringObligatorio

A workspace from GET /workspaces.

Cuerpo de la petición

mutedbooleanObligatorio

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

Devuelve

The notification settings as they are now.

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

PUT/account/photo

Set your profile photo

Alcancesaccount:writeCambia datos

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.

Cuerpo de la petición

Tipo de contenidoimage/png, image/jpeg, image/webp, image/gif

binary

Devuelve

The photo, with its new url.

Errores

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.

Los errores que puede devolver cualquier operación400401403404500Catálogo de errores

También disponible en

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

GET/account/username

Read your username

Alcancesaccount:readLee

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.

Devuelve

The username.

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

PUT/account/username

Choose your username

Alcancesaccount:writeCambia datos

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.

Cuerpo de la petición

usernamestringObligatorio
Hasta 60 caracteres

Devuelve

The username, now chosen.

Errores

409

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

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

GET/account/username/availability

Check a username

Alcancesaccount:readLee

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

usernamestringObligatorio

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

Devuelve

The verdict.

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

GET/account/connected-apps

List your connected apps

Alcancesaccount:readLee

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.

Devuelve

The connected apps.

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

DELETE/account/connected-apps/{clientId}

Remove a connected app

Alcancesaccount: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 ruta

clientIdstringObligatorio

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

Devuelve

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

GET/account/invitations

List your invitations

Alcancesaccount:readLee

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.

Devuelve

The invitations.

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

POST/account/invitations/{invitationId}/accept

Accept an invitation

Alcancesaccount:writeCambia datos

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 ruta

invitationIdstringObligatorio

The invitation id from GET /account/invitations.

Cuerpo de la petición

activateboolean

Devuelve

Errores

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.

Los errores que puede devolver cualquier operación400401404422500Catálogo de errores

También disponible en

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

POST/account/invitations/{invitationId}/decline

Decline an invitation

Alcancesaccount: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 ruta

invitationIdstringObligatorio

The invitation id from GET /account/invitations.

Devuelve

Declined.

Errores

Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores

También disponible en

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

Objetos

AcceptedInvitationobject

objectstringObligatorio
Uno de"invitation"
idstringObligatorio
acceptedbooleanObligatorio
Uno detrue
workspaceIdstringObligatorio
workspaceNamestringObligatorio
addressesGrantedintegerObligatorio
Al menos 0
domainsGrantedintegerObligatorio
Al menos 0
activatedbooleanObligatorio

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

AccountPhotoobject

objectstringObligatorio
Uno de"account_photo"
urlstringObligatorio
Puede ser null

ConnectedAppobject

objectstringObligatorio
Uno de"connected_app"
clientIdstringObligatorio
namestringObligatorio
Puede ser null
kindstringObligatorio

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

Uno de"app""cli"
cliDevicestring
Puede ser null
currentbooleanObligatorio

Whether it is the app making this call.

registeredByAccountboolean
redirectUrisstring[]
connectedAtstring
Puede ser nullFormatodate-time
accessUntilstring

When its last token runs out.

Puede ser nullFormatodate-time
tokenCountintegerObligatorio
Al menos 0
statusstringObligatorio
Uno de"active""expired""needs-approval""access-lost"
usablePermissionsinteger

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

Puede ser null
elevatedUntilstring

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

Puede ser nullFormatodate-time
grantobject

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

Puede ser null
workspaceIdstringObligatorio

The one workspace the app acts for.

workspaceNamestringObligatorio
Puede ser null
permissionsstring[]Obligatorio
addressAllowliststring[]Obligatorio
Puede ser null
domainAllowliststring[]Obligatorio
Puede ser null
expiresAtstringObligatorio

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

Puede ser nullFormatodate-time
updatedAtstringObligatorio
Formatodate-time

DeclinedInvitationobject

objectstringObligatorio
Uno de"invitation"
idstringObligatorio
declinedbooleanObligatorio
Uno detrue

EmailNotificationSettingobject

categorystringObligatorio
Uno de"account""billing""activity""product"
labelstringObligatorio
descriptionstringObligatorio
requiredbooleanObligatorio

Whether it can never be turned off.

enabledbooleanObligatorio

NotificationSettingsobject

objectstringObligatorio
Uno de"notification_settings"
emailEmailNotificationSetting[]Obligatorio

Every kind of email OpenEmail sends.

mutedWorkspacesstring[]Obligatorio

The workspaces whose notifications are muted on the phone.

ReceivedInvitationobject

objectstringObligatorio
Uno de"invitation"
idstringObligatorio
workspaceIdstringObligatorio
workspaceNamestringObligatorio
roleNamestringObligatorio
inviterNamestring
Puede ser null
addressesintegerObligatorio

How many addresses and whole domains it gives.

Al menos 0
expiresAtstringObligatorio
Formatodate-time
createdAtstringObligatorio
Formatodate-time

RevokedConnectedAppobject

objectstringObligatorio
Uno de"connected_app"
clientIdstringObligatorio
revokedbooleanObligatorio
Uno detrue
tokensRevokedintegerObligatorio
Al menos 0

Usernameobject

objectstringObligatorio
Uno de"username"
usernamestringObligatorio
Puede ser null
chosenbooleanObligatorio

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

addressstringObligatorio

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

Puede ser null

UsernameAvailabilityobject

objectstringObligatorio
Uno de"username_availability"
usernamestringObligatorio

The username as it was checked.

statusstringObligatorio

current when it is the username the person already has.

Uno de"available""current""taken""reserved""invalid""too_short""too_long"
availablebooleanObligatorio
messagestringObligatorio