Updates the workspace with the specified id.

Required Permissions

The user must be an admin or have workspace-manage-config:write permissions.

Path parameters

workspaceIdUUIDRequired

The id of the workspace.

Request

This endpoint expects an object.

allowSocialLoginbooleanRequired

Whether the social login via apple and google is allowed.

allowCredentialsLoginbooleanRequired

Whether the user can login with username and password.

namestring or nullOptional<=1000 characters

The workspace name. Optional.

descriptionstring or nullOptional<=1000 characters

The workspace description. Optional.

languagestring or nullOptional<=25 characters

The workspace language. Optional.

typestring or nullOptional<=25 characters

The workspace type / industry set during onboarding. Optional.

sizestring or nullOptional<=100 characters

The workspace size. Optional.

goalslist of stringsOptional

The workspace team goals. Optional.

selfAttributionstring or nullOptional<=100 characters

The way the workspace creator learned awork, set during the onboarding. Optional.

previousToolstring or nullOptional<=100 characters

The project management tool used before awork, set during the onboarding. Optional.

departmentstring or nullOptional<=100 characters

The workspace creator's department, set during the onboarding. Optional.

allowAutomaticScimUserBookingboolean or nullOptional

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.

sameDomainSignupEnabledboolean or nullOptional

Whether same domain signup feature is enabled. Only admins are allowed to change this setting.

sameDomainSignupRoleIdUUID or nullOptional

Default Role for users who sign up through same domain signup. Only admins are allowed to change this setting.

sameDomainSignupDomainslist of stringsOptional

Domains enabled for same domain signup feature. Only admins are allowed to change this setting.

skipCreateDefaultWorkspaceDataboolean or nullOptional

Whether to skip the creation of default workspace data.

Response

allowSocialLoginboolean

Whether the social login via apple and google is allowed.

allowCredentialsLoginboolean

Whether the user can login with username and password.

namestring or null<=1000 characters

The workspace name. Optional.

descriptionstring or null<=1000 characters

The workspace description. Optional.

languagestring or null<=25 characters

The workspace language. Optional.

typestring or null<=25 characters

The workspace type / industry set during onboarding. Optional.

sizestring or null<=100 characters

The workspace size. Optional.

goalslist of strings or null

The workspace team goals. Optional.

selfAttributionstring or null<=100 characters

The way the workspace creator learned awork, set during the onboarding. Optional.

previousToolstring or null<=100 characters

The project management tool used before awork, set during the onboarding. Optional.

departmentstring or null<=100 characters

The workspace creator's department, set during the onboarding. Optional.

allowAutomaticScimUserBookingboolean or null

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.

sameDomainSignupEnabledboolean or null

Whether same domain signup feature is enabled. Only admins are allowed to change this setting.

sameDomainSignupRoleIdUUID or null

Default Role for users who sign up through same domain signup. Only admins are allowed to change this setting.

sameDomainSignupDomainslist of strings or null

Domains enabled for same domain signup feature. Only admins are allowed to change this setting.

skipCreateDefaultWorkspaceDataboolean or null

Whether to skip the creation of default workspace data.

idUUID or null

The id of the workspace.

subdomainslist of objects or null

The workspace’s subdomains. Read-only.

memberCountinteger or null

The amount of workspace members. Only visible when the user is authenticated. Read-only.

lastUsedboolean or null

Whether this is the workspace the current user last logged in with.

lastLogindatetime or null

The date and time the user last logged in with this workspace, or the workspace was last accessed.

accountIdslist of UUIDs or null

The ids of identities assigned to this workspace. Read-only.

hasImageboolean or null

Whether the workspace has uploaded a workspace image.

createdOndatetime or null

The date this workspace was created.

createdByUUID or null

The id of the user who created this workspace. Only set after the first invitation succeeded.

updatedOndatetime or null

The date this workspace was last modified.

updatedByUUID or null

The id of the user who last updated this workspace. Only set after the first invitation succeeded.

isTestWorkspaceboolean or null

Whether the workspace is a test workspace.

isApprovedboolean or null

Whether the user accepted the invitation to the workspace.

allowSSOLoginboolean or null

Whether the user can login via an external SSO provider.

isScimActivatedboolean or null

Whether the workspace has SCIM user provisioning enabled.

virtualMRRdouble or null

The virtual MRR calculated during onborading.

isMobileSignupboolean or null

The type of sign-up set during the onboarding. Can be: web, mobile, …

isFreeMailboolean or null

Whether the domain of the account of the workspace creator is a freemail or a business domain.

isJoinableboolean or null

Whether this workspace has same domain sign up enabled and the account's email matches the permitted domains.

isFullboolean or null

Whether this workspace is full and no more users can join. Used in same domain sign up flow.

1	curl -X PUT https://api.awork.com/api/v1/workspaces/workspaceId \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "NCNSTN Creative Agency",
6	"description": "We create awesome digital experiences.",
7	"language": "de-DE",
8	"type": "creative-agency",
9	"size": "15",
10	"goals": [
11	"goals"
12	],
13	"selfAttribution": null,
14	"previousTool": null,
15	"department": "15",
16	"allowSocialLogin": false,
17	"allowCredentialsLogin": false,
18	"allowAutomaticScimUserBooking": null,
19	"sameDomainSignupEnabled": null,
20	"sameDomainSignupRoleId": "123e4567-e89b-12d3-a456-426614174000",
21	"sameDomainSignupDomains": [
22	"sameDomainSignupDomains"
23	],
24	"skipCreateDefaultWorkspaceData": null
25	}'

1	{
2	"name": "NCNSTN Creative Agency",
3	"description": "We create awesome digital experiences.",
4	"language": "de-DE",
5	"type": "creative-agency",
6	"size": "15",
7	"goals": [
8	"goals"
9	],
10	"selfAttribution": null,
11	"previousTool": null,
12	"department": "15",
13	"allowSocialLogin": false,
14	"allowCredentialsLogin": false,
15	"allowAutomaticScimUserBooking": null,
16	"sameDomainSignupEnabled": null,
17	"sameDomainSignupRoleId": "123e4567-e89b-12d3-a456-426614174000",
18	"sameDomainSignupDomains": [
19	"sameDomainSignupDomains"
20	],
21	"skipCreateDefaultWorkspaceData": null,
22	"id": "123e4567-e89b-12d3-a456-426614174000",
23	"subdomains": [
24	{
25	"name": "ncnstn",
26	"isDefault": true
27	}
28	],
29	"memberCount": 25,
30	"lastUsed": true,
31	"lastLogin": null,
32	"accountIds": [
33	"accountIds"
34	],
35	"hasImage": true,
36	"createdOn": "createdOn",
37	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
38	"updatedOn": "updatedOn",
39	"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
40	"isTestWorkspace": false,
41	"isApproved": true,
42	"allowSSOLogin": true,
43	"isScimActivated": false,
44	"virtualMRR": null,
45	"isMobileSignup": null,
46	"isFreeMail": null,
47	"isJoinable": false,
48	"isFull": null
49	}

Required Permissions

Path parameters

Headers

Request

Response