Update document

PATCH /v1/documents/{id}

Update document

cURL

curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/document/v1/documents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "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.",
  "documentIcon": "link-outlined",
  "documentOwnerId": "550e8400-e29b-41d4-a716-446655440003",
  "documentOwnerUsername": "John Doe",
  "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",
  "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": {
    "responsibleUsername": "Neha Patel",
    "responsibleUserId": "550e8400-e29b-41d4-a716-446655440023"
  },
  "documentLinking": {
    "decisionLinkAllowed": true,
    "delegationLinkAllowed": true
  }
}
EOF

200

{
  "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

documentName · string · required

Name of the document

Maximum string length: 150

Example:

"Global Delegation of Authority Policy - ProxyComm Inc."

documentDescription · string · required

Description of the document

Maximum string length: 250

Example:

"Defines the framework for delegating authority across ProxyComm's global operations, outlining roles, responsibilities, and decision-making limits."

documentIcon · string · required

Icon representing the document

Maximum string length: 20

Example:

"link-outlined"

documentOwnerId · string<uuid> · required

Unique identifier of the document owner

Example:

"550e8400-e29b-41d4-a716-446655440003"

documentOwnerUsername · string · required

Document owner username

Maximum string length: 100

Example:

"John Doe"

documentMetadata · object

Metadata of the document in JSON format

Example:

"{ \"code\": \"GOV-DFA-2\", \"version\": \"2024.2\" }"

fileId · string<uuid>

Unique identifier for the associated file for UPLOADED documents

Example:

"550e8400-e29b-41d4-a716-446655440001"

documentTypeId · string<uuid>

Optional identifier for document type

Example:

"550e8400-e29b-41d4-a716-446655440002"

documentTypeName · string

Document type name

Maximum string length: 255

Example:

"Policy"

documentStatus · enum<string> · default: DRAFT

Status of the document

Available options: DRAFT, PUBLISHED

Example:

"DRAFT"

documentSharingType · enum<string>

Sharing type of the document

Available options: PUBLIC, RESTRICTED, SHARED

Example:

"RESTRICTED"

documentUploadType · enum<string>

Type of document upload

Available options: LINKED, UPLOADED

Example:

"LINKED"

documentUrl · string

Url for the LINKED document

Example:

"intranet.sharepoint.proxycomm.com/2024delegationofauthority.policy"

documentSharingGroups · object[]

Document Sharing Groups

Show child attributes

Example:

[
  {
    "groupId": "550e8400-e29b-41d4-a716-446655440013",
    "tenantGroupTypeId": "550e8400-e29b-41d4-a716-446655440023"
  }
]

documentSharingUsers · object[]

Document Sharing Users

Show child attributes

Example:

[
  {
    "userId": "550e8400-e29b-41d4-a716-446655440033"
  }
]

documentOversights · object

Document Sharing Groups

Show child attributes

Example:

{
  "responsibleUsername": "Neha Patel",
  "responsibleUserId": "550e8400-e29b-41d4-a716-446655440023"
}

documentLinking · object

Document Linking with decisions and delegations

Show child attributes

Example:

{
  "decisionLinkAllowed": true,
  "delegationLinkAllowed": true
}

Response

200 - application/json

Document updated successfully

id · string · required

Unique identifier

Example:

"550e8400-e29b-41d4-a716-446655440100"

tenantId · string · required

Unique identifier for the tenant

Example:

"550e8400-e29b-41d4-a716-446655440000"

documentName · string · required

Name of the document

Example:

"Global Delegation of Authority Policy - ProxyComm Inc."

documentDescription · string · required

Description of the document

Example:

"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 · object · required

Metadata of the document in JSON format

Example:

"{ \"code\": \"GOV-DFA-2\", \"version\": \"2024.2\" }"

fileId · string | null · required

Unique identifier for the associated file

Example:

"550e8400-e29b-41d4-a716-446655440001"

documentTypeId · string | null · required

Optional identifier for document type

Example:

"550e8400-e29b-41d4-a716-446655440002"

documentStatus · enum<string> · required

Status of the document

Available options: DRAFT, PUBLISHED, ARCHIVED, DELETED

Example:

"DRAFT"

documentSharingType · enum<string> · required

Sharing type of the document

Available options: PUBLIC, RESTRICTED, SHARED

Example:

"RESTRICTED"

documentIcon · string · required

Icon representing the document

Example:

"link-outlined"

documentOwnerId · string · required

Unique identifier of the document owner

Example:

"550e8400-e29b-41d4-a716-446655440003"

documentUploadType · enum<string> · required

Type of document upload

Available options: LINKED, UPLOADED

Example:

"LINKED"

documentUrl · string | null · required

Url for the LINKED document

Example:

"intranet.sharepoint.proxycomm.com/2024delegationofauthority.policy"

uploadedOn · string<date-time> · required

Date when the document was uploaded

Example:

"2025-02-13T12:00:00Z"

lastUpdatedBy · string | null · required

Unique identifier of the last user who updated the document

Example:

"550e8400-e29b-41d4-a716-446655440004"

lastUpdatedOn · string<date-time> | null · required

Date when the document was last updated

Example:

"2025-02-14T15:30:00Z"

archivedOn · string<date-time> | null · required

Date when the document was archived

Example:

"2025-03-01T10:00:00Z"

deletedOn · string<date-time> | null · required

Date when the document was deleted

Example:

"2025-04-01T12:00:00Z"

documentDisplayId · string · required

Document Display ID

Example:

"10000"

link · string · required

Document Link

Example:

"/documents/view/eyJ0ZW5hbnRJZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsImRvY3VtZW50SWQiOiJjMDBjMGNkNy03ZmJjLTRmZTEtOWYxMy1lYzc5OTlmMjhjNDgifQ=="