आपका अकाउंट
इस समूह का हर ऑपरेशन: वह क्या लेता है, क्या लौटाता है और किन त्रुटियों के साथ जवाब दे सकता है।
ऑपरेशन
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
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आवश्यक