POST api/users/me/properties/{userPropertyId}/documents/types/{documentTypeId}?isClientVisible={isClientVisible}&categoryId={categoryId}

This method should be used to upload document for a user property

Request Information

URI Parameters

Name	Description	Type	Additional information
userPropertyId	User property record id	integer	Required
documentTypeId	Target document type id that will be uploaded	integer	Required
isClientVisible	Client visibility flag	boolean	Default value is False
categoryId	Id of the Client Document Category	integer	None.

Body Parameters

None.

Response Information

Resource Description

Instance of

UploadedPropertyDocumentResponseModel

Name	Type	Additional information
Id	integer	None.
UserPropertyId	integer	None.
UploadDocumentTypeId	integer	None.
UploadDocumentType	string	None.
Name	string	None.
FilePath	string	None.
OwnerUserId	integer	None.
OwnerFullName	string	None.
OwnerRoleId	integer	None.
UploadDate	date	None.
ClientDocumentCategoryId	integer	None.
CategoryName	string	None.
IsClientVisible	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "userPropertyId": 2,
  "uploadDocumentTypeId": 3,
  "uploadDocumentType": "sample string 4",
  "name": "sample string 5",
  "filePath": "sample string 6",
  "ownerUserId": 7,
  "ownerFullName": "sample string 8",
  "ownerRoleId": 9,
  "uploadDate": "2025-05-20T14:40:18.7098351-05:00",
  "clientDocumentCategoryId": 1,
  "categoryName": "sample string 11",
  "isClientVisible": true
}

text/html

Sample:

{"id":1,"userPropertyId":2,"uploadDocumentTypeId":3,"uploadDocumentType":"sample string 4","name":"sample string 5","filePath":"sample string 6","ownerUserId":7,"ownerFullName":"sample string 8","ownerRoleId":9,"uploadDate":"2025-05-20T14:40:18.7098351-05:00","clientDocumentCategoryId":1,"categoryName":"sample string 11","isClientVisible":true}

application/xml, text/xml

Sample:

<UploadedPropertyDocumentResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.PropertyBinding">
  <CategoryName>sample string 11</CategoryName>
  <ClientDocumentCategoryId>1</ClientDocumentCategoryId>
  <FilePath>sample string 6</FilePath>
  <Id>1</Id>
  <IsClientVisible>true</IsClientVisible>
  <Name>sample string 5</Name>
  <OwnerFullName>sample string 8</OwnerFullName>
  <OwnerRoleId>9</OwnerRoleId>
  <OwnerUserId>7</OwnerUserId>
  <UploadDate>2025-05-20T14:40:18.7098351-05:00</UploadDate>
  <UploadDocumentType>sample string 4</UploadDocumentType>
  <UploadDocumentTypeId>3</UploadDocumentTypeId>
  <UserPropertyId>2</UserPropertyId>
</UploadedPropertyDocumentResponseModel>