워크스페이스
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
The workspaces the person behind the key or the app can open: the ones they own and the ones they joined, and which one the app opens 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. The key or the app itself still acts for exactly one workspace in every other call.
GET/workspaces
List your workspaces
Every workspace the person can open, the ones they own first, as the workspace switcher of the app lists them. activeWorkspaceId is the one the app opens for them, primaryWorkspaceId the first one they made, which cannot be deleted, and personalWorkspaceId their personal space, which holds their free address and is not listed.
Requires the account:read scope.
반환값
The workspaces.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
POST/workspaces
Create a workspace
Makes a new workspace owned by the person, on the Free plan, and makes it the one the app opens for them, as creating one in the app does. An account can own one Free workspace, so while it owns one the call is a 403 workspace_allowance_reached that names it: upgrade that workspace first. Sending the same name twice within ten seconds returns the workspace the first call made.
Requires the account:write scope.
요청 본문
namestring필수Up to 64 characters. Leading and trailing spaces are trimmed.
1~64자
반환값
The new workspace.
오류
- 403
workspace_allowance_reached: the account already owns a workspace on the Free plan. Upgrade it before creating another.insufficient_scopewhen the key or the app lacksaccount:write.
모든 작업이 반환할 수 있는 오류400401404422500오류 목록
다른 사용처
GET/workspaces/active
Read the workspace the app opens
The workspace the app opens for the person when they sign in, or the one it falls back to when they never chose one. It is not the workspace the key or the app acts on, which never changes.
Requires the account:read scope.
반환값
The workspace the app opens.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
PUT/workspaces/active
Choose the workspace the app opens
Switches the workspace the app opens for the person, as the workspace switcher does, to any workspace they can open. A workspace they cannot open is a 404. It changes nothing for the key or the app making the call.
Requires the account:write scope.
요청 본문
workspaceIdstring필수- 1~128자
반환값
The workspace the app opens now.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
DELETE/workspaces/{id}
Delete the workspace
Deletes the workspace the key or the app belongs to, with its domains, addresses, mail and members, and cancels its plan. It is for good. confirm has to be the name of the workspace, as the app asks the person to type it. Only the owner may do it: a member's access token is refused with 403 owner_only, and a key or an app limited to particular addresses or domains with 422 capability_unsupported. The first workspace an account made cannot be deleted (409 first_workspace), and neither can one with a domain being moved in or out (409 domain_moving). The key that deleted its own workspace stops working with it.
Requires the account:write scope.
경로 매개변수
idstring필수The id of the workspace the key or the app belongs to. Any other id is a 404.
쿼리 매개변수
confirmstring필수The name of the workspace, as
GET /workspaceslists it. Letter case and the spaces around it do not matter.최대 256자
반환값
Deleted.
오류
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
first_workspace: the first workspace an account made cannot be deleted.domain_moving: a domain is being moved into or out of it, so try again when the move has finished.- 502
plan_not_cancelled: the plan on the workspace could not be cancelled, so the workspace was kept. Try again in a moment.
모든 작업이 반환할 수 있는 오류400401404422500오류 목록
다른 사용처
객체
ActiveWorkspaceobject
objectstring필수- 다음 중 하나
"workspace" idstring필수namestring필수- null 가능
slugstring필수- null 가능
emailstring필수- null 가능
kindstring필수personalfor the personal space,businessfor every other workspace.다음 중 하나"business""personal"isOwnerboolean필수createdAtstring필수- 형식
date-time
CreatedWorkspaceobject
objectstring필수- 다음 중 하나
"workspace" idstring필수namestring필수slugstring필수activeboolean필수The app opens the new workspace for the person from now on.
다음 중 하나true
DeletedWorkspaceobject
objectstring필수- 다음 중 하나
"workspace" idstring필수deletedboolean필수- 다음 중 하나
true activeWorkspaceIdstring필수The first workspace of the account, which the app opens when the deleted one was open.
null 가능
Workspaceobject
objectstring필수- 다음 중 하나
"workspace" idstring필수namestring필수The name the app shows for it.
slugstring필수- null 가능
emailstring필수The address the workspace was made for, or null while it has none.
null 가능isOwnerboolean필수Whether the person owns it rather than joined it.
ownerIdstring필수The account id of its owner.
planstring필수- 다음 중 하나
"free""starter""business""enterprise" markUrlstringIts square logo, when it has one.
null 가능wordmarkUrlstringIts wide logo, when it has one.
null 가능createdAtstring필수- 형식
date-time
WorkspaceListobject
objectstring필수- 다음 중 하나
"list" dataWorkspace[]필수activeWorkspaceIdstring필수The workspace the app opens for the person.
null 가능primaryWorkspaceIdstring필수The first workspace they made, which cannot be deleted.
null 가능personalWorkspaceIdstring필수Their personal space, which is not in
data.null 가능