حساب شما
هر عملیات در این گروه: آنچه میپذیرد، آنچه برمیگرداند و خطاهایی که ممکن است با آنها پاسخ دهد.
عملیاتها
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.
/account/notifications/account/notifications/email/{category}/account/notifications/push/{workspaceId}/account/photo/account/photo/account/username/account/username/account/username/availability/account/connected-apps/account/connected-apps/{clientId}/account/invitations/account/invitations/{invitationId}/accept/account/invitations/{invitationId}/decline
GET/account/notifications
Read your notification settings
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فهرست خطاها
همچنین در دسترس در
PUT/account/notifications/email/{category}
Turn a kind of email on or off
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فهرست خطاها
همچنین در دسترس در
PUT/account/notifications/push/{workspaceId}
Mute a workspace on your phone
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فهرست خطاها
همچنین در دسترس در
PUT/account/photo
Set your profile photo
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
خروجی
The photo, with its new url.
خطاها
- 422
invalid_imagewhen 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فهرست خطاها
همچنین در دسترس در
DELETE/account/photo
Remove your profile photo
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فهرست خطاها
همچنین در دسترس در
GET/account/username
Read your username
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فهرست خطاها
همچنین در دسترس در
PUT/account/username
Choose your username
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فهرست خطاها
همچنین در دسترس در
GET/account/username/availability
Check a username
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فهرست خطاها
همچنین در دسترس در
GET/account/connected-apps
List your connected apps
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فهرست خطاها
همچنین در دسترس در
DELETE/account/connected-apps/{clientId}
Remove a connected app
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
clientIdfromGET /account/connected-apps.
خروجی
Removed.
خطاها
خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها
همچنین در دسترس در
GET/account/invitations
List your invitations
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فهرست خطاها
همچنین در دسترس در
POST/account/invitations/{invitationId}/accept
Accept an invitation
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
خروجی
Joined.
خطاها
- 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فهرست خطاها
همچنین در دسترس در
POST/account/invitations/{invitationId}/decline
Decline an invitation
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فهرست خطاها
همچنین در دسترس در
اشیا
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الزامیclifor a sign-in of the command line tool,appfor every other app.یکی از"app""cli"cliDevicestring- میتواند null باشد
currentbooleanالزامیWhether it is the app making this call.
registeredByAccountbooleanredirectUrisstring[]connectedAtstring- میتواند null باشدقالب
date-time accessUntilstringWhen its last token runs out.
میتواند null باشدقالبdate-timetokenCountintegerالزامی- دستکم 0
statusstringالزامی- یکی از
"active""expired""needs-approval""access-lost" usablePermissionsintegerHow many of the permissions it was given the person still holds.
میتواند null باشدelevatedUntilstringUntil when it may make changes that ask for a verification code without one.
میتواند null باشدقالبdate-timegrantobjectWhat 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-timeupdatedAtstringالزامی- قالب
date-time
ConnectedAppListobject
objectstring- یکی از
"list" dataConnectedApp[]
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.
دستکم 0expiresAtstringالزامی- قالب
date-time createdAtstringالزامی- قالب
date-time
ReceivedInvitationListobject
objectstring- یکی از
"list"
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الزامیcurrentwhen it is the username the person already has.یکی از"available""current""taken""reserved""invalid""too_short""too_long"availablebooleanالزامیmessagestringالزامی