Updates the workspace with the specified id.

PUT

Required Permissions

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

Path parameters

workspaceIdstringRequired

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.

namestringOptional<=1000 characters

The workspace name. Optional.

descriptionstringOptional<=1000 characters

The workspace description. Optional.

languagestringOptional<=25 characters

The workspace language. Optional.

typestringOptional<=25 characters

The workspace type. Optional.

sizestringOptional<=100 characters

The workspace size. Optional.

goalslist of stringsOptional

The workspace team goals. Optional.

selfAttributionstringOptional<=100 characters

The way the workspace noticed awork, set during the onboarding.

previousToolstringOptional<=100 characters

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

allowAutomaticScimUserBookingbooleanOptional

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.

sameDomainSignupEnabledbooleanOptional

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

sameDomainSignupRoleIdstringOptionalformat: "uuid"

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.

skipCreateDefaultWorkspaceDatabooleanOptional

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.

namestringOptional<=1000 characters

The workspace name. Optional.

descriptionstringOptional<=1000 characters

The workspace description. Optional.

languagestringOptional<=25 characters

The workspace language. Optional.

typestringOptional<=25 characters

The workspace type. Optional.

sizestringOptional<=100 characters

The workspace size. Optional.

goalslist of stringsOptional

The workspace team goals. Optional.

selfAttributionstringOptional<=100 characters

The way the workspace noticed awork, set during the onboarding.

previousToolstringOptional<=100 characters

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

allowAutomaticScimUserBookingbooleanOptional

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.

sameDomainSignupEnabledbooleanOptional

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

sameDomainSignupRoleIdstringOptionalformat: "uuid"

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.

skipCreateDefaultWorkspaceDatabooleanOptional

Whether to skip the creation of default workspace data.

idstringOptionalformat: "uuid"

The id of the workspace.

subdomainslist of objectsOptional

The workspace’s subdomains. Read-only.

memberCountintegerOptional

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

lastUsedbooleanOptional

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

lastLogindatetimeOptional

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

accountIdslist of stringsOptional

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

hasImagebooleanOptional

Whether the workspace has uploaded a workspace image.

createdOndatetimeOptional

The date this workspace was created.

createdBystringOptionalformat: "uuid"

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

updatedOndatetimeOptional

The date this workspace was last modified.

updatedBystringOptionalformat: "uuid"

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

isTestWorkspacebooleanOptional

Whether the workspace is a test workspace.

isApprovedbooleanOptional

Whether the user accepted the invitation to the workspace.

allowSSOLoginbooleanOptional

Whether the user can login via an external SSO provider.

isScimActivatedbooleanOptional

Whether the workspace has SCIM user provisioning enabled.

virtualMRRdoubleOptional

The virtual MRR calculated during onborading.

isMobileSignupbooleanOptional

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

isFreeMailbooleanOptional

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

isJoinablebooleanOptional

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

isFullbooleanOptional

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

PUT

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   "allowSocialLogin": true,
6   "allowCredentialsLogin": true
7 }'

200Updated

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

API Management Overview

Up Next

Built with

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	"allowSocialLogin": true,
6	"allowCredentialsLogin": true
7	}'

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