SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceDocument Spaces

Deletes the document space with the specified id.

DELETE
https://api.awork.com/api/v1/documentspaces/:documentSpaceId
DELETE
/api/v1/documentspaces/:documentSpaceId
1curl -X DELETE https://api.awork.com/api/v1/documentspaces/documentSpaceId \
2     -H "Authorization: Bearer <token>"
Try it
200Deleted
1{
2  "id": "123e4567-e89b-12d3-a456-426614174000",
3  "createdOn": "2024-01-15T09:30:00Z",
4  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
5  "updatedOn": "2024-01-15T09:30:00Z",
6  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
7  "name": "string",
8  "emoji": "string",
9  "color": "purple",
10  "order": 1.1,
11  "workspaceAccessLevel": "string",
12  "contributors": [
13    {
14      "id": "123e4567-e89b-12d3-a456-426614174000",
15      "userId": "123e4567-e89b-12d3-a456-426614174000",
16      "accessLevel": "string",
17      "firstName": "Lisa",
18      "lastName": "Smith",
19      "hasImage": true,
20      "isDeactivated": false
21    }
22  ],
23  "teams": [
24    {
25      "id": "123e4567-e89b-12d3-a456-426614174000",
26      "teamId": "123e4567-e89b-12d3-a456-426614174000",
27      "accessLevel": "string",
28      "name": "Designers",
29      "icon": "paintbrush",
30      "color": "purple"
31    }
32  ]
33}
Corresponding documents and their related entities will be unrecoverably deleted in the background asynchronously. <Check><b>Required Permissions</b>: The user has to be an admin.</Check>
Was this page helpful?
Previous

Adds a list of document space contributors to a document space with the specified id.

Next
Built with
Adds a list of document space contributors to a document space with the specified id.

Corresponding documents and their related entities will be unrecoverably deleted in the background asynchronously.

Required Permissions: The user has to be an admin.

Authentication

AuthorizationBearer

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

Path Parameters

documentSpaceIdstringRequiredformat: "uuid"
The document space id.

Response

OK
idstring or nullformat: "uuid"
createdOnstring or nullformat: "date-time"
createdBystring or nullformat: "uuid"
updatedOnstring or nullformat: "date-time"
updatedBystring or nullformat: "uuid"
namestring or null
The name of the document space.
emojistring or null
The emoji of the document space.
colorstring or null
The color of the document space for display purposes in the app. Can be null when no color assigned.
orderdouble or null
The order of the document space in the list of document spaces.
workspaceAccessLevelstring or null

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 null
The contributors of this document space.
teamslist of objects or null
The teams this document space is connected to.