Update Document Member

PUT /api/v1.0/docs/{document_id}/members

This endpoint updates document's members list

Path parameters

Body Required

  • members array[object] Required

    Document Invitee details

    Hide members attributes Show members attributes array[object]
    • id string Required

      ID

    • permission string Required

      Permission

      Values are view, comment, or edit.

  • folder_stack array[string]

    Folder stack

Responses

  • Success Response

    Hide response attributes Show response attributes object
  • The record doesn't exist.

  • The client request has not been completed because it lacks valid authentication credentials for the requested resource.

  • The client does not have access rights to the content.

  • The request method is known by the server but is not supported by the target resource.

PUT /api/v1.0/docs/{document_id}/members
curl \
 -X PUT https://openapi.niftypm.com/api/v1.0/docs/{document_id}/members \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"members":[{"id":"string","permission":"view"}],"folder_stack":["string"]}'
Request example
{
  "members": [
    {
      "id": "string",
      "permission": "view"
    }
  ],
  "folder_stack": [
    "string"
  ]
}
Request examples
{
  "members": [
    {
      "id": "string",
      "permission": "view"
    }
  ],
  "folder_stack": [
    "string"
  ]
}
Response examples (200)
{
  "message": "string",
  "added_members": [
    "string"
  ],
  "updated_members": [
    "string"
  ]
}
Response examples (200)
{
  "message": "string",
  "added_members": [
    "string"
  ],
  "updated_members": [
    "string"
  ]
}