Update document approval

PATCH /v1/documents/document-approval/{id}

Update document approval

cURL

curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/document/v1/documents/document-approval/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reviewerUserId": "550e8400-e29b-41d4-a716-446655440003",
  "reviewerUsername": "John Doe",
  "reviewerPositionId": "550e8400-e29b-41d4-a716-446655440004",
  "reviewerPositionName": "Sr. Corporate Counsel",
  "approverUserId": "550e8400-e29b-41d4-a716-446655440005",
  "approverUsername": "John Doe",
  "approverPositionId": "550e8400-e29b-41d4-a716-446655440006",
  "approverPositionName": "Sr. Corporate Counsel",
  "reviewStatus": "REVIEWED",
  "approvalStatus": "APPROVED"
}
'

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

reviewerUserId · string | null

User ID of the reviewer

Example:

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

reviewerUsername · string | null

Username of the reviewer

Example:

"John Doe"

reviewerPositionId · string | null

Position ID of the reviewer

Example:

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

reviewerPositionName · string | null

Position name of the reviewer

Example:

"Sr. Corporate Counsel"

approverUserId · string | null

User ID of the approver

Example:

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

approverUsername · string | null

Username of the approver

Example:

"John Doe"

approverPositionId · string | null

Position ID of the approver

Example:

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

approverPositionName · string | null

Position name of the approver

Example:

"Sr. Corporate Counsel"

reviewStatus · object

Review status

Example:

"REVIEWED"

approvalStatus · object

Approval status

Example:

"APPROVED"

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