PATCH
/
v1
/
documents
/
settings
/
{id}
/
version-oversight
Update document version oversight settings
curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/document/v1/documents/settings/{id}/version-oversight \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "documentOversightSettings": {
    "id": "550e8400-e29b-41d4-a716-446655440012",
    "owner": "true",
    "responsibleAuthority": "true",
    "approvalAuthority": "true",
    "generateApprovalAction": "true",
    "reviewerAuthority": "true",
    "generateReviewAction": "true"
  },
  "documentVersionTypeInfo": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440012",
      "status": "true"
    }
  ]
}'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:01.116Z",
  "message": "Success",
  "data": {
    "documentOversightSettings": {
      "documentId": "550e8400-e29b-41d4-a716-446655440100",
      "tenantId": "550e8400-e29b-41d4-a716-446655440100",
      "owner": "true",
      "responsibleAuthority": "true",
      "approvalAuthority": "true",
      "generateApprovalAction": "true",
      "reviewerAuthority": "true",
      "generateReviewAction": "true"
    },
    "documentVersionTypeInfo": [
      {
        "documentId": "550e8400-e29b-41d4-a716-446655440100",
        "documentVersionTypeId": "550e8400-e29b-41d4-a716-446655440100",
        "documentVersionTypeValue": "Version"
      }
    ],
    "oversightActionAssociation": [
      {
        "isApprovalActionExist": "true/false",
        "isReviewerActionExist": "true/false"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json

Response

200 - application/json

Document settings updated successfully

The response is of type object.