Documents

Add a document user

Changed on

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

post/documents.add_user

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/documents.add_user
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

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

    • info

      added the optional property /// to the response with the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status