Belgelere geç
API

Hesabınız

Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.

İşlemler

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

Kapsamlaraccount:readOkur

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.

Döndürür

The notification settings.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

PUT/account/notifications/email/{category}

Turn a kind of email on or off

Kapsamlaraccount:writeVeriyi değiştirir

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.

Yol parametreleri

categorystringZorunlu

The kind of email.

Şunlardan biri"account""billing""activity""product"

İstek gövdesi

enabledbooleanZorunlu

True to receive that email, false to stop it.

Döndürür

The notification settings as they are now.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

PUT/account/notifications/push/{workspaceId}

Mute a workspace on your phone

Kapsamlaraccount:writeVeriyi değiştirir

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.

Yol parametreleri

workspaceIdstringZorunlu

A workspace from GET /workspaces.

İstek gövdesi

mutedbooleanZorunlu

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

Döndürür

The notification settings as they are now.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

PUT/account/photo

Set your profile photo

Kapsamlaraccount:writeVeriyi değiştirir

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.

İstek gövdesi

İçerik türüimage/png, image/jpeg, image/webp, image/gif

binary

Döndürür

The photo, with its new url.

Hatalar

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.

Her işlemin döndürebileceği hatalar400401403404500Hata kataloğu

Şurada da var

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

GET/account/username

Read your username

Kapsamlaraccount:readOkur

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.

Döndürür

The username.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

PUT/account/username

Choose your username

Kapsamlaraccount:writeVeriyi değiştirir

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.

İstek gövdesi

usernamestringZorunlu
En çok 60 karakter

Döndürür

The username, now chosen.

Hatalar

409

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

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

GET/account/username/availability

Check a username

Kapsamlaraccount:readOkur

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

Requires the account:read scope.

Sorgu parametreleri

usernamestringZorunlu

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

1 ile 60 karakter arası

Döndürür

The verdict.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

GET/account/connected-apps

List your connected apps

Kapsamlaraccount:readOkur

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.

Döndürür

The connected apps.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

DELETE/account/connected-apps/{clientId}

Remove a connected app

Kapsamlaraccount:writeSiler

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.

Yol parametreleri

clientIdstringZorunlu

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

Döndürür

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

POST/account/invitations/{invitationId}/accept

Accept an invitation

Kapsamlaraccount:writeVeriyi değiştirir

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.

Yol parametreleri

invitationIdstringZorunlu

The invitation id from GET /account/invitations.

İstek gövdesi

activateboolean

Döndürür

Hatalar

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.

Her işlemin döndürebileceği hatalar400401404422500Hata kataloğu

Şurada da var

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

POST/account/invitations/{invitationId}/decline

Decline an invitation

Kapsamlaraccount:writeSiler

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.

Yol parametreleri

invitationIdstringZorunlu

The invitation id from GET /account/invitations.

Döndürür

Declined.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

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

Nesneler

AcceptedInvitationobject

objectstringZorunlu
Şunlardan biri"invitation"
idstringZorunlu
acceptedbooleanZorunlu
Şunlardan biritrue
workspaceIdstringZorunlu
workspaceNamestringZorunlu
addressesGrantedintegerZorunlu
En az 0
domainsGrantedintegerZorunlu
En az 0
activatedbooleanZorunlu

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

AccountPhotoobject

objectstringZorunlu
Şunlardan biri"account_photo"
urlstringZorunlu
null olabilir

ConnectedAppobject

objectstringZorunlu
Şunlardan biri"connected_app"
clientIdstringZorunlu
namestringZorunlu
null olabilir
kindstringZorunlu

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

Şunlardan biri"app""cli"
cliDevicestring
null olabilir
currentbooleanZorunlu

Whether it is the app making this call.

registeredByAccountboolean
redirectUrisstring[]
connectedAtstring
null olabilirBiçimdate-time
accessUntilstring

When its last token runs out.

null olabilirBiçimdate-time
tokenCountintegerZorunlu
En az 0
statusstringZorunlu
Şunlardan biri"active""expired""needs-approval""access-lost"
usablePermissionsinteger

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

null olabilir
elevatedUntilstring

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

null olabilirBiçimdate-time
grantobject

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

null olabilir
workspaceIdstringZorunlu

The one workspace the app acts for.

workspaceNamestringZorunlu
null olabilir
permissionsstring[]Zorunlu
addressAllowliststring[]Zorunlu
null olabilir
domainAllowliststring[]Zorunlu
null olabilir
expiresAtstringZorunlu

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

null olabilirBiçimdate-time
updatedAtstringZorunlu
Biçimdate-time

ConnectedAppListobject

objectstring
Şunlardan biri"list"

DeclinedInvitationobject

objectstringZorunlu
Şunlardan biri"invitation"
idstringZorunlu
declinedbooleanZorunlu
Şunlardan biritrue

EmailNotificationSettingobject

categorystringZorunlu
Şunlardan biri"account""billing""activity""product"
labelstringZorunlu
descriptionstringZorunlu
requiredbooleanZorunlu

Whether it can never be turned off.

enabledbooleanZorunlu

NotificationSettingsobject

objectstringZorunlu
Şunlardan biri"notification_settings"
emailEmailNotificationSetting[]Zorunlu

Every kind of email OpenEmail sends.

mutedWorkspacesstring[]Zorunlu

The workspaces whose notifications are muted on the phone.

ReceivedInvitationobject

objectstringZorunlu
Şunlardan biri"invitation"
idstringZorunlu
workspaceIdstringZorunlu
workspaceNamestringZorunlu
roleNamestringZorunlu
inviterNamestring
null olabilir
addressesintegerZorunlu

How many addresses and whole domains it gives.

En az 0
expiresAtstringZorunlu
Biçimdate-time
createdAtstringZorunlu
Biçimdate-time

RevokedConnectedAppobject

objectstringZorunlu
Şunlardan biri"connected_app"
clientIdstringZorunlu
revokedbooleanZorunlu
Şunlardan biritrue
tokensRevokedintegerZorunlu
En az 0

Usernameobject

objectstringZorunlu
Şunlardan biri"username"
usernamestringZorunlu
null olabilir
chosenbooleanZorunlu

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

addressstringZorunlu

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

null olabilir

UsernameAvailabilityobject

objectstringZorunlu
Şunlardan biri"username_availability"
usernamestringZorunlu

The username as it was checked.

statusstringZorunlu

current when it is the username the person already has.

Şunlardan biri"available""current""taken""reserved""invalid""too_short""too_long"
availablebooleanZorunlu
messagestringZorunlu