documents

Updates a document team's access.

Changed on

Updates the specified team's access to the document. Access for related entities is recalculated asynchronously. <Check title="Required Permissions" icon="key">The user must have at least write permission for the specified document.</Check>

put/documents/{documentId}/teams/{documentToTeamId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/documents/{documentId}/teams/{documentToTeamId}
  • Auth: HTTP bearer

Path parameters

documentIdstring uuid required

The id of the document.

documentToTeamIdstring uuid required

The id of the document to team connection to update.

Request body

accessLevel'read' | 'manage' required

Determines the level of access granted to this contributor or team with respect to the referenced entity. Can be either set to read or manage where read allows viewing the entity and manage allows full control over it (read, write and permission changes).

Response

OK

idstring uuid

The id of the entity to team.

teamIdstring uuid

The id of the team this entity to team references.

accessLevelstring nullable

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutDocumentTeamByDocumentIdAndDocumentToTeamId removed and replaced with documents_PutDocumentTeamByDocumentIdAndDocumentToTeamId