Llogaria juaj
Çdo veprim në këtë grup: çfarë pranon, çfarë kthen dhe gabimet me të cilat mund të përgjigjet.
Veprimet
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.
Kthen
The notification settings.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
categorystringE detyrueshmeThe kind of email.
Një nga"account""billing""activity""product"
Trupi i kërkesës
enabledbooleanE detyrueshmeTrue to receive that email, false to stop it.
Kthen
The notification settings as they are now.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
workspaceIdstringE detyrueshmeA workspace from
GET /workspaces.
Trupi i kërkesës
mutedbooleanE detyrueshmeTrue to mute it, false to let it notify again.
Kthen
The notification settings as they are now.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Trupi i kërkesës
Lloji i përmbajtjesimage/png, image/jpeg, image/webp, image/gif
Kthen
The photo, with its new url.
Gabimet
- 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.
Gabimet që mund të kthejë çdo veprim400401403404500Katalogu i gabimeve
E disponueshme edhe në
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.
Kthen
Removed, with url null.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Kthen
The username.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Trupi i kërkesës
usernamestringE detyrueshme- Deri në 60 karaktere
Kthen
The username, now chosen.
Gabimet
- 409
username_locked: the username was chosen before and never changes.username_taken: another account has it.
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e pyetjes
usernamestringE detyrueshmeThe username to check. It is lowercased and its spaces become dots before it is checked, as the app does.
Nga 1 deri në 60 karaktere
Kthen
The verdict.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Kthen
The connected apps.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
clientIdstringE detyrueshmeThe app's
clientIdfromGET /account/connected-apps.
Kthen
Removed.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Kthen
The invitations.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
invitationIdstringE detyrueshmeThe invitation id from
GET /account/invitations.
Trupi i kërkesës
activateboolean
Kthen
Joined.
Gabimet
- 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.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
invitationIdstringE detyrueshmeThe invitation id from
GET /account/invitations.
Kthen
Declined.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
Objektet
AcceptedInvitationobject
objectstringE detyrueshme- Një nga
"invitation" idstringE detyrueshmeacceptedbooleanE detyrueshme- Një nga
true workspaceIdstringE detyrueshmeworkspaceNamestringE detyrueshmeaddressesGrantedintegerE detyrueshme- Të paktën 0
domainsGrantedintegerE detyrueshme- Të paktën 0
activatedbooleanE detyrueshmeWhether the app now opens the workspace, after
activate: true.
AccountPhotoobject
objectstringE detyrueshme- Një nga
"account_photo" urlstringE detyrueshme- Mund të jetë null
ConnectedAppobject
objectstringE detyrueshme- Një nga
"connected_app" clientIdstringE detyrueshmenamestringE detyrueshme- Mund të jetë null
kindstringE detyrueshmeclifor a sign-in of the command line tool,appfor every other app.Një nga"app""cli"cliDevicestring- Mund të jetë null
currentbooleanE detyrueshmeWhether it is the app making this call.
registeredByAccountbooleanredirectUrisstring[]connectedAtstring- Mund të jetë nullFormati
date-time accessUntilstringWhen its last token runs out.
Mund të jetë nullFormatidate-timetokenCountintegerE detyrueshme- Të paktën 0
statusstringE detyrueshme- Një nga
"active""expired""needs-approval""access-lost" usablePermissionsintegerHow many of the permissions it was given the person still holds.
Mund të jetë nullelevatedUntilstringUntil when it may make changes that ask for a verification code without one.
Mund të jetë nullFormatidate-timegrantobjectWhat the person gave it, or null for an app that has to ask again.
Mund të jetë nullworkspaceIdstringE detyrueshmeThe one workspace the app acts for.
workspaceNamestringE detyrueshme- Mund të jetë null
permissionsstring[]E detyrueshmeaddressAllowliststring[]E detyrueshme- Mund të jetë null
domainAllowliststring[]E detyrueshme- Mund të jetë null
expiresAtstringE detyrueshmeWhen the access ends, or null when it lasts until it is removed.
Mund të jetë nullFormatidate-timeupdatedAtstringE detyrueshme- Formati
date-time
ConnectedAppListobject
objectstring- Një nga
"list" dataConnectedApp[]
DeclinedInvitationobject
objectstringE detyrueshme- Një nga
"invitation" idstringE detyrueshmedeclinedbooleanE detyrueshme- Një nga
true
EmailNotificationSettingobject
categorystringE detyrueshme- Një nga
"account""billing""activity""product" labelstringE detyrueshmedescriptionstringE detyrueshmerequiredbooleanE detyrueshmeWhether it can never be turned off.
enabledbooleanE detyrueshme
NotificationSettingsobject
objectstringE detyrueshme- Një nga
"notification_settings" emailEmailNotificationSetting[]E detyrueshmeEvery kind of email OpenEmail sends.
mutedWorkspacesstring[]E detyrueshmeThe workspaces whose notifications are muted on the phone.
ReceivedInvitationobject
objectstringE detyrueshme- Një nga
"invitation" idstringE detyrueshmeworkspaceIdstringE detyrueshmeworkspaceNamestringE detyrueshmeroleNamestringE detyrueshmeinviterNamestring- Mund të jetë null
addressesintegerE detyrueshmeHow many addresses and whole domains it gives.
Të paktën 0expiresAtstringE detyrueshme- Formati
date-time createdAtstringE detyrueshme- Formati
date-time
ReceivedInvitationListobject
objectstring- Një nga
"list"
RevokedConnectedAppobject
objectstringE detyrueshme- Një nga
"connected_app" clientIdstringE detyrueshmerevokedbooleanE detyrueshme- Një nga
true tokensRevokedintegerE detyrueshme- Të paktën 0
Usernameobject
objectstringE detyrueshme- Një nga
"username" usernamestringE detyrueshme- Mund të jetë null
chosenbooleanE detyrueshmeWhether the person chose it. A chosen username never changes.
addressstringE detyrueshmeThe free address the username gives, when this deployment offers one.
Mund të jetë null
UsernameAvailabilityobject
objectstringE detyrueshme- Një nga
"username_availability" usernamestringE detyrueshmeThe username as it was checked.
statusstringE detyrueshmecurrentwhen it is the username the person already has.Një nga"available""current""taken""reserved""invalid""too_short""too_long"availablebooleanE detyrueshmemessagestringE detyrueshme