client.workspaces
Chaque méthode de cet espace de noms : sa signature, ses paramètres, ce qu'elle retourne et un exemple.
Méthodes
The workspaces the person behind the key or the app can open: list them, create one, choose the one the app opens, and delete the workspace the key or the app belongs to. An API key acts for the workspace owner, and an app for the person who connected it.
workspaces.list
List your workspaces
list(api_key: nil) -> HashReturns every workspace the person behind the client can open, the ones they own first, as the workspace switcher of the app lists them. It is about the person, not the workspace the key belongs to. An API key answers for the workspace owner, and an app for the person who connected it.
activeWorkspaceId is the workspace the app opens for them, primaryWorkspaceId the first one they made, which can never be deleted, and personalWorkspaceId their personal space, which holds their free address and is not in data.
Paramètres
api_keyStringOverrides the client's API key for this call only.
Retourne
A Hash with data, an Array of Hashes, one per workspace, and activeWorkspaceId, primaryWorkspaceId and personalWorkspaceId.
Exemple
workspaces = client.workspaces.list workspaces[:data].each do |workspace| label = (workspace[:id] == workspaces[:activeWorkspaceId]) ? "(open in the app)" : "" puts "#{workspace[:name]} #{label}"endRemarques
The key or the app still acts for its own workspace in every other call.
Aussi disponible dans
- API
GET /workspaces- TypeScript
workspaces.list()- Python
workspaces.list()- CLI
openemail workspaces list
workspaces.create
Create a workspace
create(body = nil, api_key: nil, **fields) -> HashMakes a new workspace owned by the person, on the Free plan, and makes it the workspace the app opens for them, as creating one in the app does. The key or the app making the call keeps acting for its own workspace.
An account can own one workspace on the Free plan. While it owns one, the call is refused with 403 workspace_allowance_reached and the message names that workspace: upgrade it first.
Paramètres
nameStringObligatoireUp to 64 characters. Leading and trailing spaces are trimmed.
api_keyStringOverrides the client's API key for this call only.
Retourne
A Hash with id, name, slug and active set to true.
Exemple
workspace = client.workspaces.create(name: "Acme Support") puts workspace[:id], workspace[:slug]Remarques
Not retried automatically. The same name sent twice within ten seconds returns the workspace the first call made, so a retry right after a lost response is safe.
Aussi disponible dans
- API
POST /workspaces- TypeScript
workspaces.create()- Python
workspaces.create()- CLI
openemail workspaces create
workspaces.get_active
Read the workspace the app opens
get_active(api_key: nil) -> HashReturns 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.
Paramètres
api_keyStringOverrides the client's API key for this call only.
Retourne
A Hash with id, name, slug, email, kind, isOwner and createdAt.
Exemple
opened = client.workspaces.get_active puts opened[:name], opened[:kind]Remarques
kindispersonalwhen the app opens the personal space.
Aussi disponible dans
workspaces.set_active
Choose the workspace the app opens
set_active(workspace_id, api_key: nil) -> HashSwitches the workspace the app opens for the person, as the workspace switcher does, to any workspace they can open. It changes nothing for the key or the app making the call, which keeps acting for its own workspace.
Paramètres
workspace_idStringObligatoireA workspace id from
list.api_keyStringOverrides the client's API key for this call only.
Retourne
The same Hash as workspaces.get_active, for the workspace the app opens now.
Exemple
client.workspaces.set_active("10417196-e324-4283-af98-66ec62167c47")Remarques
A workspace the person cannot open is a 404
resource_not_found.Retried automatically on network failure, since choosing the same workspace twice changes nothing.
Aussi disponible dans
workspaces.delete
Delete the workspace
delete(id, confirm:, api_key: nil) -> HashDeletes the workspace the key or the app belongs to, with its domains, addresses, mail and members, and cancels its plan. It cannot be undone. confirm: has to be the name of the workspace, as list shows it, the same way the app asks the person to type it.
Only the owner may do it. An access token acting for a member is refused with 403 owner_only, and a key or an app limited to particular addresses or domains with 422 capability_unsupported. Any other workspace id is a 404, the first workspace an account made is refused with 409 first_workspace, and one with a domain being moved in or out with 409 domain_moving.
Paramètres
idStringObligatoireThe id of the workspace the key or the app belongs to, which
me.getreports asworkspaceId.confirmStringObligatoireThe name of the workspace. Letter case and the spaces around it do not matter. Sent as a query parameter.
api_keyStringOverrides the client's API key for this call only.
Retourne
A Hash with id, deleted set to true and activeWorkspaceId, the workspace the app opens from now on.
Exemple
client.workspaces.delete("10417196-e324-4283-af98-66ec62167c47", confirm: "Acme Support")Remarques
An OAuth access token needs a verification code for this call, and is refused with 403
step_up_requireduntil the app has verified one in the last 60 minutes.step_up_required?on the error says so. An API key is never asked for a code.The key or the app loses its workspace with it, so every later call with it is refused.
Not retried automatically. A retry after a lost response is a 404, since the workspace is already gone.
Aussi disponible dans
- API
DELETE /workspaces/{id}- TypeScript
workspaces.delete()- Python
workspaces.delete()- CLI
openemail workspaces delete