Updates the document space with the specified id.

PUT

https://api.awork.com/api/v1/documentspaces/:documentSpaceId

PUT

/api/v1/documentspaces/:documentSpaceId

$ curl -X PUT https://api.awork.com/api/v1/documentspaces/documentSpaceId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3   "createdOn": "2023-11-20T09:45:00.000Z",
4   "createdBy": "a3bb189e-8bf9-3888-9912-ace4e6543002",
5   "updatedOn": "2024-04-10T16:30:00.000Z",
6   "updatedBy": "b1a7c9d2-4f3e-4d2a-9f3b-1a2b3c4d5e6f",
7   "name": "Marketing Documents",
8   "isExternal": false,
9   "emoji": "📁",
10   "color": "blue",
11   "order": 2.5,
12   "workspaceAccessLevel": "manage",
13   "contributors": [
14     {
15       "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
16       "userId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
17       "accessLevel": "manage",
18       "firstName": "Lisa",
19       "lastName": "Smith",
20       "hasImage": true,
21       "isDeactivated": false
22     }
23   ],
24   "teams": [
25     {
26       "id": "e7d13b5a-9f3b-4c2a-8a1b-2d3e4f5a6b7c",
27       "teamId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
28       "accessLevel": "read",
29       "name": "Designers",
30       "icon": "paintbrush",
31       "color": "purple"
32     }
33   ]
34 }

Required Permissions

The user must be an admin.

<Check title="Required Permissions" icon="key">The user must be an admin.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

documentSpaceIdstringRequiredformat: "uuid"

The id of the document space.

Request

The model used to update the document space.

namestring or nullOptional0-1000 characters

The name of the document space.

emojistring or nullOptional0-25 characters

The emoji of the document space.

colorstring or nullOptional0-14 characters

The color of the document space for display purposes in the app. Can be null when no color assigned.

orderdouble or nullOptional

The order of the document space in the list of document spaces.

workspaceAccessLevelenum or nullOptional

Determines the level of access to this document space granted to all workspace users. Can be either none, read, or manage.

Response

idstringOptionalformat: "uuid"

The id of the entity.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

namestring or nullOptional

The name of the document space.

isExternalbooleanOptional

Whether this document space is coming from an external workspace (awork Connect).

emojistring or nullOptional

The emoji of the document space.

colorstring or nullOptional

The color of the document space for display purposes in the app. Can be null when no color assigned.

orderdouble or nullOptional

The order of the document space in the list of document spaces.

workspaceAccessLevelstring or nullOptional

Determines the level of access to this document space granted to all workspace users. Can be either not set (no access), read, or manage.

contributorslist of objects or nullOptional

The contributors of this document space.

teamslist of objects or nullOptional

The teams this document space is connected to.

Errors

401

Unauthorized Error

404

Not Found Error