تخطَّ إلى المستندات
API

حسابك

كل عملية في هذه المجموعة: ما تقبله وما تُرجعه والأخطاء التي قد تردّ بها.

العمليات

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

الصلاحياتaccount:readيقرأ

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.

يُرجع

The notification settings.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

PUT/account/notifications/email/{category}

Turn a kind of email on or off

الصلاحياتaccount:writeيغيّر البيانات

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.

معلمات المسار

categorystringمطلوب

The kind of email.

أحد"account""billing""activity""product"

متن الطلب

enabledbooleanمطلوب

True to receive that email, false to stop it.

يُرجع

The notification settings as they are now.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

PUT/account/notifications/push/{workspaceId}

Mute a workspace on your phone

الصلاحياتaccount:writeيغيّر البيانات

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.

معلمات المسار

workspaceIdstringمطلوب

A workspace from GET /workspaces.

متن الطلب

mutedbooleanمطلوب

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

يُرجع

The notification settings as they are now.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

PUT/account/photo

Set your profile photo

الصلاحياتaccount:writeيغيّر البيانات

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.

متن الطلب

نوع المحتوىimage/png, image/jpeg, image/webp, image/gif

binary

يُرجع

The photo, with its new url.

الأخطاء

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.

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404500دليل الأخطاء

متاح أيضًا في

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

DELETE/account/photo

Remove your profile photo

الصلاحياتaccount:writeيحذف

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.

يُرجع

Removed, with url null.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

GET/account/username

Read your username

الصلاحياتaccount:readيقرأ

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.

يُرجع

The username.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

PUT/account/username

Choose your username

الصلاحياتaccount:writeيغيّر البيانات

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.

متن الطلب

usernamestringمطلوب
حتى 60 من الأحرف

يُرجع

The username, now chosen.

الأخطاء

409

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

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

GET/account/username/availability

Check a username

الصلاحياتaccount:readيقرأ

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

Requires the account:read scope.

معلمات الاستعلام

usernamestringمطلوب

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

من 1 إلى 60 من الأحرف

يُرجع

The verdict.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

GET/account/connected-apps

List your connected apps

الصلاحياتaccount:readيقرأ

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.

يُرجع

The connected apps.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

DELETE/account/connected-apps/{clientId}

Remove a connected app

الصلاحياتaccount:writeيحذف

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.

معلمات المسار

clientIdstringمطلوب

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

يُرجع

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

GET/account/invitations

List your invitations

الصلاحياتaccount:readيقرأ

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.

يُرجع

The invitations.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

POST/account/invitations/{invitationId}/accept

Accept an invitation

الصلاحياتaccount:writeيغيّر البيانات

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.

معلمات المسار

invitationIdstringمطلوب

The invitation id from GET /account/invitations.

متن الطلب

activateboolean

يُرجع

الأخطاء

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.

الأخطاء التي يمكن أن تُرجعها أي عملية400401404422500دليل الأخطاء

متاح أيضًا في

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

POST/account/invitations/{invitationId}/decline

Decline an invitation

الصلاحياتaccount:writeيحذف

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.

معلمات المسار

invitationIdstringمطلوب

The invitation id from GET /account/invitations.

يُرجع

Declined.

الأخطاء

الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء

متاح أيضًا في

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

الكائنات

AcceptedInvitationobject

objectstringمطلوب
أحد"invitation"
idstringمطلوب
acceptedbooleanمطلوب
أحدtrue
workspaceIdstringمطلوب
workspaceNamestringمطلوب
addressesGrantedintegerمطلوب
على الأقل 0
domainsGrantedintegerمطلوب
على الأقل 0
activatedbooleanمطلوب

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

AccountPhotoobject

objectstringمطلوب
أحد"account_photo"
urlstringمطلوب
يمكن أن يكون null

ConnectedAppobject

objectstringمطلوب
أحد"connected_app"
clientIdstringمطلوب
namestringمطلوب
يمكن أن يكون null
kindstringمطلوب

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

أحد"app""cli"
cliDevicestring
يمكن أن يكون null
currentbooleanمطلوب

Whether it is the app making this call.

registeredByAccountboolean
redirectUrisstring[]
connectedAtstring
يمكن أن يكون nullالتنسيقdate-time
accessUntilstring

When its last token runs out.

يمكن أن يكون nullالتنسيقdate-time
tokenCountintegerمطلوب
على الأقل 0
statusstringمطلوب
أحد"active""expired""needs-approval""access-lost"
usablePermissionsinteger

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

يمكن أن يكون null
elevatedUntilstring

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

يمكن أن يكون nullالتنسيقdate-time
grantobject

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

يمكن أن يكون null
workspaceIdstringمطلوب

The one workspace the app acts for.

workspaceNamestringمطلوب
يمكن أن يكون null
permissionsstring[]مطلوب
addressAllowliststring[]مطلوب
يمكن أن يكون null
domainAllowliststring[]مطلوب
يمكن أن يكون null
expiresAtstringمطلوب

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

يمكن أن يكون nullالتنسيقdate-time
updatedAtstringمطلوب
التنسيقdate-time

DeclinedInvitationobject

objectstringمطلوب
أحد"invitation"
idstringمطلوب
declinedbooleanمطلوب
أحدtrue

EmailNotificationSettingobject

categorystringمطلوب
أحد"account""billing""activity""product"
labelstringمطلوب
descriptionstringمطلوب
requiredbooleanمطلوب

Whether it can never be turned off.

enabledbooleanمطلوب

NotificationSettingsobject

objectstringمطلوب
أحد"notification_settings"
emailEmailNotificationSetting[]مطلوب

Every kind of email OpenEmail sends.

mutedWorkspacesstring[]مطلوب

The workspaces whose notifications are muted on the phone.

ReceivedInvitationobject

objectstringمطلوب
أحد"invitation"
idstringمطلوب
workspaceIdstringمطلوب
workspaceNamestringمطلوب
roleNamestringمطلوب
inviterNamestring
يمكن أن يكون null
addressesintegerمطلوب

How many addresses and whole domains it gives.

على الأقل 0
expiresAtstringمطلوب
التنسيقdate-time
createdAtstringمطلوب
التنسيقdate-time

RevokedConnectedAppobject

objectstringمطلوب
أحد"connected_app"
clientIdstringمطلوب
revokedbooleanمطلوب
أحدtrue
tokensRevokedintegerمطلوب
على الأقل 0

Usernameobject

objectstringمطلوب
أحد"username"
usernamestringمطلوب
يمكن أن يكون null
chosenbooleanمطلوب

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

addressstringمطلوب

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

يمكن أن يكون null

UsernameAvailabilityobject

objectstringمطلوب
أحد"username_availability"
usernamestringمطلوب

The username as it was checked.

statusstringمطلوب

current when it is the username the person already has.

أحد"available""current""taken""reserved""invalid""too_short""too_long"
availablebooleanمطلوب
messagestringمطلوب