Update Document

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

This endpoint updates document using unique document id with given data.

Path parameters

  • document_id string Required

    Document ID

application/json

Body Required

  • name string

    Document name

  • archived boolean

    Archived

  • access_type string

    Values are public, limited, or personal.

  • force boolean

    Force Flag

  • content object
  • folder_id string

    Folder ID

  • folder_stack array[string]

    Folder path stack

  • multipage boolean

    Is Multiple page?

  • order number

    Document Order

Responses

  • 200 application/json

    Success Response

    Hide response attributes Show response attributes object
    • message string Required

      Message

    • doc_id string Required

      Document ID
  • 204

    The record doesn't exist.

  • 401

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

  • 403

    The client does not have access rights to the content.

  • 405

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

PUT /api/v1.0/docs/{document_id} 
curl \
 --request PUT 'https://openapi.niftypm.com/api/v1.0/docs/{document_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"string","archived":true,"access_type":"public","force":true,"content":{},"folder_id":"string","folder_stack":["string"],"multipage":true,"order":42.0}'
Request examples 
{
  "name": "string",
  "archived": true,
  "access_type": "public",
  "force": true,
  "content": {},
  "folder_id": "string",
  "folder_stack": [
    "string"
  ],
  "multipage": true,
  "order": 42.0
}
Response examples (200) 
{
  "message": "string",
  "doc_id": "string"
}