Aller à la documentation
API

Votre compte

Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.

Opérations

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

Portéesaccount:readLit

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.

Retourne

The notification settings.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

PUT/account/notifications/email/{category}

Turn a kind of email on or off

Portéesaccount:writeModifie des données

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.

Paramètres de chemin

categorystringObligatoire

The kind of email.

L'un de"account""billing""activity""product"

Corps de la requête

enabledbooleanObligatoire

True to receive that email, false to stop it.

Retourne

The notification settings as they are now.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

PUT/account/notifications/push/{workspaceId}

Mute a workspace on your phone

Portéesaccount:writeModifie des données

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.

Paramètres de chemin

workspaceIdstringObligatoire

A workspace from GET /workspaces.

Corps de la requête

mutedbooleanObligatoire

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

Retourne

The notification settings as they are now.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

PUT/account/photo

Set your profile photo

Portéesaccount:writeModifie des données

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.

Corps de la requête

Type de contenuimage/png, image/jpeg, image/webp, image/gif

binary

Retourne

The photo, with its new url.

Erreurs

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.

Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs

Aussi disponible dans

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

GET/account/username

Read your username

Portéesaccount:readLit

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.

Retourne

The username.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

PUT/account/username

Choose your username

Portéesaccount:writeModifie des données

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.

Corps de la requête

usernamestringObligatoire
Jusqu'à 60 caractères

Retourne

The username, now chosen.

Erreurs

409

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

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

GET/account/username/availability

Check a username

Portéesaccount:readLit

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

Requires the account:read scope.

Paramètres de requête

usernamestringObligatoire

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

De 1 à 60 caractères

Retourne

The verdict.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

GET/account/connected-apps

List your connected apps

Portéesaccount:readLit

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.

Retourne

The connected apps.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

DELETE/account/connected-apps/{clientId}

Remove a connected app

Portéesaccount:writeSupprime

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.

Paramètres de chemin

clientIdstringObligatoire

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

Retourne

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

GET/account/invitations

List your invitations

Portéesaccount:readLit

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.

Retourne

The invitations.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

POST/account/invitations/{invitationId}/accept

Accept an invitation

Portéesaccount:writeModifie des données

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.

Paramètres de chemin

invitationIdstringObligatoire

The invitation id from GET /account/invitations.

Corps de la requête

activateboolean

Retourne

Erreurs

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.

Les erreurs que toute opération peut renvoyer400401404422500Catalogue des erreurs

Aussi disponible dans

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

POST/account/invitations/{invitationId}/decline

Decline an invitation

Portéesaccount:writeSupprime

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.

Paramètres de chemin

invitationIdstringObligatoire

The invitation id from GET /account/invitations.

Retourne

Declined.

Erreurs

Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs

Aussi disponible dans

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

Objets

AcceptedInvitationobject

objectstringObligatoire
L'un de"invitation"
idstringObligatoire
acceptedbooleanObligatoire
L'un detrue
workspaceIdstringObligatoire
workspaceNamestringObligatoire
addressesGrantedintegerObligatoire
Au moins 0
domainsGrantedintegerObligatoire
Au moins 0
activatedbooleanObligatoire

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

AccountPhotoobject

objectstringObligatoire
L'un de"account_photo"
urlstringObligatoire
Peut être null

ConnectedAppobject

objectstringObligatoire
L'un de"connected_app"
clientIdstringObligatoire
namestringObligatoire
Peut être null
kindstringObligatoire

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

L'un de"app""cli"
cliDevicestring
Peut être null
currentbooleanObligatoire

Whether it is the app making this call.

registeredByAccountboolean
redirectUrisstring[]
connectedAtstring
Peut être nullFormatdate-time
accessUntilstring

When its last token runs out.

Peut être nullFormatdate-time
tokenCountintegerObligatoire
Au moins 0
statusstringObligatoire
L'un de"active""expired""needs-approval""access-lost"
usablePermissionsinteger

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

Peut être null
elevatedUntilstring

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

Peut être nullFormatdate-time
grantobject

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

Peut être null
workspaceIdstringObligatoire

The one workspace the app acts for.

workspaceNamestringObligatoire
Peut être null
permissionsstring[]Obligatoire
addressAllowliststring[]Obligatoire
Peut être null
domainAllowliststring[]Obligatoire
Peut être null
expiresAtstringObligatoire

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

Peut être nullFormatdate-time
updatedAtstringObligatoire
Formatdate-time

DeclinedInvitationobject

objectstringObligatoire
L'un de"invitation"
idstringObligatoire
declinedbooleanObligatoire
L'un detrue

EmailNotificationSettingobject

categorystringObligatoire
L'un de"account""billing""activity""product"
labelstringObligatoire
descriptionstringObligatoire
requiredbooleanObligatoire

Whether it can never be turned off.

enabledbooleanObligatoire

NotificationSettingsobject

objectstringObligatoire
L'un de"notification_settings"
emailEmailNotificationSetting[]Obligatoire

Every kind of email OpenEmail sends.

mutedWorkspacesstring[]Obligatoire

The workspaces whose notifications are muted on the phone.

ReceivedInvitationobject

objectstringObligatoire
L'un de"invitation"
idstringObligatoire
workspaceIdstringObligatoire
workspaceNamestringObligatoire
roleNamestringObligatoire
inviterNamestring
Peut être null
addressesintegerObligatoire

How many addresses and whole domains it gives.

Au moins 0
expiresAtstringObligatoire
Formatdate-time
createdAtstringObligatoire
Formatdate-time

RevokedConnectedAppobject

objectstringObligatoire
L'un de"connected_app"
clientIdstringObligatoire
revokedbooleanObligatoire
L'un detrue
tokensRevokedintegerObligatoire
Au moins 0

Usernameobject

objectstringObligatoire
L'un de"username"
usernamestringObligatoire
Peut être null
chosenbooleanObligatoire

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

addressstringObligatoire

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

Peut être null

UsernameAvailabilityobject

objectstringObligatoire
L'un de"username_availability"
usernamestringObligatoire

The username as it was checked.

statusstringObligatoire

current when it is the username the person already has.

L'un de"available""current""taken""reserved""invalid""too_short""too_long"
availablebooleanObligatoire
messagestringObligatoire