Skip to main content
POST
/
v1
/
documents
Create document
curl --request POST \
  --url https://staging.api.us.aptlydone.com/document/v1/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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.",
  "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"
    }
  ],
  "responsibleUserId": "550e8400-e29b-41d4-a716-446655440033",
  "reviewerUserId": "550e8400-e29b-41d4-a716-446655440033",
  "approverUserId": "550e8400-e29b-41d4-a716-446655440033",
  "responsibleUsername": "Responsible user name ",
  "reviewerUsername": "Reviewer user name ",
  "approverUsername": "Approver user name",
  "approverPositionId": "550e8400-e29b-41d4-a716-446655440023",
  "responsiblePositionId": "550e8400-e29b-41d4-a716-446655440023",
  "reviewerPositionId": "550e8400-e29b-41d4-a716-446655440023",
  "approverPositionName": "Approver position name",
  "reviewerPositionName": "Reviewer position name",
  "responsiblePositionName": "Responsible position name",
  "isExternal": "true"
}'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:01.116Z",
  "message": "Success",
  "data": {
    "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.

Body

application/json
​
tenantId
string<uuid>
required

Unique identifier for the tenant

Example:

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

​
documentName
string
required

Name of the document

Maximum length: 150
Example:

"Global Delegation of Authority Policy - ProxyComm Inc."

​
documentDescription
string
required

Description of the document

Maximum 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 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 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 length: 255
Example:

"Policy"

​
documentStatus
enum<string>
default:DRAFT

Status of the document

Available options:
DRAFT,
PUBLISHED
Example:

"DRAFT"

​
documentSharingType
enum<string>
default:RESTRICTED

Sharing type of the document

Available options:
PUBLIC,
RESTRICTED,
SHARED
Example:

"RESTRICTED"

​
documentUploadType
enum<string>
default:LINKED

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

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

Document Sharing Users

Example:
[
  {
    "userId": "550e8400-e29b-41d4-a716-446655440033"
  }
]
​
responsibleUserId
string

Responsibe user id for document

Example:

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

​
reviewerUserId
string

Reviewer user id for document

Example:

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

​
approverUserId
string

Approver user id for document

Example:

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

​
responsibleUsername
string

Responsibe user name for document

Example:

"Responsible user name "

​
reviewerUsername
string

Reviewer user name for document

Example:

"Reviewer user name "

​
approverUsername
string

Approver user name for document

Example:

"Approver user name"

​
approverPositionId
string

Approver position id for document

Example:

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

​
responsiblePositionId
string

Responsiblr position id for document

Example:

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

​
reviewerPositionId
string

Reviewer position id for document

Example:

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

​
approverPositionName
string

Approver position name for document

Example:

"Approver position name"

​
reviewerPositionName
string

Reviewer position name for document

Example:

"Reviewer position name"

​
responsiblePositionName
string

Responsible position name for document

Example:

"Responsible position name"

​
isExternal
boolean

Check Document creation from decision or delegation

Example:

"true"

Response

201 - application/json

Document created successfully

​
statusCode
number
required

HTTP Status code

Example:

200

​
timestamp
string
required

Timestamp of the response

Example:

"2025-06-24T08:51:01.116Z"

​
message
string
required

Response message

Example:

"Success"

​
data
object
required

Response data