PATCH
/
v1
/
documents
/
{id}
Update document
curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/document/v1/documents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "documentName": "Global Delegation of Authority Policy - ProxyComm Inc.",
  "documentDescription": "Defines the framework for delegating authority across ProxyComm'\''s global operations, outlining roles, responsibilities, and decision-making limits.",
  "documentMetadata": "{ \"code\": \"GOV-DFA-2\", \"version\": \"2024.2\" }",
  "fileId": "550e8400-e29b-41d4-a716-446655440001",
  "documentTypeId": "550e8400-e29b-41d4-a716-446655440002",
  "documentTypeName": "Policy",
  "documentStatus": "DRAFT",
  "documentSharingType": "RESTRICTED",
  "documentIcon": "link-outlined",
  "documentOwnerId": "550e8400-e29b-41d4-a716-446655440003",
  "documentOwnerUsername": "John Doe",
  "documentUploadType": "LINKED",
  "documentUrl": "intranet.sharepoint.proxycomm.com/2024delegationofauthority.policy",
  "documentSharingGroups": [
    {
      "groupId": "550e8400-e29b-41d4-a716-446655440013",
      "tenantGroupTypeId": "550e8400-e29b-41d4-a716-446655440023"
    }
  ],
  "documentSharingUsers": [
    {
      "userId": "550e8400-e29b-41d4-a716-446655440033"
    }
  ],
  "documentOversights": {
    "documentId": "550e8400-e29b-41d4-a716-446655440013",
    "responsibleUsername": "Neha Patel",
    "responsibleUserId": "550e8400-e29b-41d4-a716-446655440023"
  },
  "documentLinking": {
    "decisionLinkAllowed": true,
    "delegationLinkAllowed": true
  }
}'
{
  "id": "550e8400-e29b-41d4-a716-446655440100",
  "tenantId": "550e8400-e29b-41d4-a716-446655440000",
  "documentName": "Global Delegation of Authority Policy - ProxyComm Inc.",
  "documentDescription": "Defines the framework for delegating authority across ProxyComm's global operations, outlining roles, responsibilities, and decision-making limits to ensure compliance, accountability, and operational consistency.",
  "documentMetadata": "{ \"code\": \"GOV-DFA-2\", \"version\": \"2024.2\" }",
  "fileId": "550e8400-e29b-41d4-a716-446655440001",
  "documentTypeId": "550e8400-e29b-41d4-a716-446655440002",
  "documentStatus": "DRAFT",
  "documentSharingType": "RESTRICTED",
  "documentIcon": "link-outlined",
  "documentOwnerId": "550e8400-e29b-41d4-a716-446655440003",
  "documentUploadType": "LINKED",
  "documentUrl": "intranet.sharepoint.proxycomm.com/2024delegationofauthority.policy",
  "uploadedOn": "2025-02-13T12:00:00Z",
  "lastUpdatedBy": "550e8400-e29b-41d4-a716-446655440004",
  "lastUpdatedOn": "2025-02-14T15:30:00Z",
  "archivedOn": "2025-03-01T10:00:00Z",
  "deletedOn": "2025-04-01T12:00:00Z",
  "documentDisplayId": "10000",
  "link": "/documents/view/eyJ0ZW5hbnRJZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsImRvY3VtZW50SWQiOiJjMDBjMGNkNy03ZmJjLTRmZTEtOWYxMy1lYzc5OTlmMjhjNDgifQ=="
}

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 updated successfully

The response is of type object.