documents

Updates a document contributor's access.

Changed on

Updates the specified contributor'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}/contributors/{documentContributorId}

Request

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

Path parameters

documentIdstring uuid required

The id of the document to update.

documentContributorIdstring uuid required

The id of the document contributor to update.

Request body

accessLevel'read' | 'manage' required

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

Response

OK

idstring uuid

The id of the contributor.

userIdstring uuid

The id of the user this contributor references.

accessLevelstring nullable

Determines the level of access granted to this contributor 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 PutDocumentContributorByDocumentIdAndDocumentContributorId removed and replaced with documents_PutDocumentContributorByDocumentIdAndDocumentContributorId