Documents

Add a document user

This method allows you to add a user membership to the specified document.

post/documents.add_user

Request body

idstring required

Unique identifier for the document. Either the UUID or the urlId is acceptable.

userIdstring uuid required
permission'read' | 'read_write'

Response

OK

Example response

{
  "data": {
    "users": [
      {
        "name": "Jane Doe"
      }
    ]
  }
}

Changes

Changed in 2 of the 6 revisions of this API.6

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 429

      response-non-success-status-added

    • endpoint added

      endpoint-added