For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Integration Example (PSA)
    • 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
      • GETReturns all document spaces.
      • POSTCreates a new document space.
      • GETReturns the document space with the specified id.
      • PUTUpdates the document space with the specified id.
      • DELDeletes the document space with the specified id.
      • POSTAdds a list of document space contributors to a document space.
      • PUTUpdates the access of a document space contributor to the document space with the specified id.
      • DELDeletes the document space contributor with the specified id from a document space.
      • POSTAdds teams to the document space with the specified id.
      • PUTUpdates the access of a team to the document space with the specified id.
      • DELDeletes the team with the specified id from a document space.
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Workflows Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceDocument Spaces

Adds a list of document space contributors to a document space.

POST
https://api.awork.com/api/v1/documentspaces/:documentSpaceId/contributors
POST
/api/v1/documentspaces/:documentSpaceId/contributors
$curl -X POST https://api.awork.com/api/v1/documentspaces/documentSpaceId/contributors \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '[
>  {
>    "accessLevel": "read",
>    "userId": "123e4567-e89b-12d3-a456-426614174000"
>  }
>]'
1{
2  "id": "123e4567-e89b-12d3-a456-426614174000",
3  "userId": "123e4567-e89b-12d3-a456-426614174000",
4  "accessLevel": "string"
5}
Adding document space contributors will affect their access to the document space and documents within that space. <Check title="Required Permissions" icon="key">The user must be an admin.</Check>
Was this page helpful?
Previous

Updates the access of a document space contributor to the document space with the specified id.

Next
Built with

Adding document space contributors will affect their access to the document space and documents within that space.

Required Permissions
The user must be an admin.

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 with the list of contributors to add.
accessLevelenumRequired

Determines the level of access granted to this contributor with respect to the referenced entity. Can be either set to read or manage.

Allowed values:
userIdstringRequiredformat: "uuid"
The id of the user this contributor references.

Response

OK
idstringformat: "uuid"
The id of the contributor.
userIdstringformat: "uuid"
The id of the user this contributor references.
accessLevelstring or null

Determines the level of access granted to this contributor with respect to the specific entity. Can be either set to read or manage.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error