Updates the workspace with the specified id.
Updates the workspace with the specified id.
Required Permissions
The user must be an admin or haveworkspace-manage-config:write
permissions.Path parameters
workspaceId
The id of the workspace.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
allowSocialLogin
Whether the social login via apple and google is allowed.
allowCredentialsLogin
Whether the user can login with username and password.
name
The workspace name. Optional.
description
The workspace description. Optional.
language
The workspace language. Optional.
type
The workspace type / industry set during onboarding. Optional.
size
The workspace size. Optional.
goals
The workspace team goals. Optional.
selfAttribution
The way the workspace creator learned awork, set during the onboarding. Optional.
previousTool
The project management tool used before awork, set during the onboarding. Optional.
department
The workspace creator's department, set during the onboarding. Optional.
allowAutomaticScimUserBooking
Whether the SCIM integration should be able to book additional user seats when provisioning and activating new users,
or should return BadRequest.
Only admins are allowed to change this setting.
sameDomainSignupEnabled
Whether same domain signup feature is enabled.
Only admins are allowed to change this setting.
sameDomainSignupRoleId
Default Role for users who sign up through same domain signup.
Only admins are allowed to change this setting.
sameDomainSignupDomains
Domains enabled for same domain signup feature.
Only admins are allowed to change this setting.
skipCreateDefaultWorkspaceData
Whether to skip the creation of default workspace data.
Response
OK
allowSocialLogin
Whether the social login via apple and google is allowed.
allowCredentialsLogin
Whether the user can login with username and password.
name
The workspace name. Optional.
description
The workspace description. Optional.
language
The workspace language. Optional.
type
The workspace type / industry set during onboarding. Optional.
size
The workspace size. Optional.
goals
The workspace team goals. Optional.
selfAttribution
The way the workspace creator learned awork, set during the onboarding. Optional.
previousTool
The project management tool used before awork, set during the onboarding. Optional.
department
The workspace creator's department, set during the onboarding. Optional.
allowAutomaticScimUserBooking
Whether the SCIM integration should be able to book additional user seats when provisioning and activating new users,
or should return BadRequest.
Only admins are allowed to change this setting.
sameDomainSignupEnabled
Whether same domain signup feature is enabled.
Only admins are allowed to change this setting.
sameDomainSignupRoleId
Default Role for users who sign up through same domain signup.
Only admins are allowed to change this setting.
sameDomainSignupDomains
Domains enabled for same domain signup feature.
Only admins are allowed to change this setting.
skipCreateDefaultWorkspaceData
Whether to skip the creation of default workspace data.
id
The id of the workspace.
subdomains
The workspace’s subdomains. Read-only.
memberCount
The amount of workspace members. Only visible when the user is authenticated. Read-only.
lastUsed
Whether this is the workspace the current user last logged in with.
lastLogin
The date and time the user last logged in with this workspace, or the workspace was last accessed.
accountIds
The ids of identities assigned to this workspace. Read-only.
hasImage
Whether the workspace has uploaded a workspace image.
createdOn
The date this workspace was created.
createdBy
The id of the user who created this workspace.
Only set after the first invitation succeeded.
updatedOn
The date this workspace was last modified.
updatedBy
The id of the user who last updated this workspace.
Only set after the first invitation succeeded.
isTestWorkspace
Whether the workspace is a test workspace.
isApproved
Whether the user accepted the invitation to the workspace.
allowSSOLogin
Whether the user can login via an external SSO provider.
isScimActivated
Whether the workspace has SCIM user provisioning enabled.
virtualMRR
The virtual MRR calculated during onborading.
isMobileSignup
The type of sign-up set during the onboarding. Can be: web, mobile, …
isFreeMail
Whether the domain of the account of the workspace creator is a freemail or a business domain.
isJoinable
Whether this workspace has same domain sign up enabled and the account's email matches the permitted domains.
isFull
Whether this workspace is full and no more users can join. Used in same domain sign up flow.