API Reference

/api/v1/projects/{projectId}/document-files

This can be used to create a new project document. This must be called after obtaining an upload URL.

Path Params
string
required
Body Params
string

The unique identifier of the source. This is a user-generated string. You can use this to link the person to a resource in an external system.

string
required

The name of the file.

string
required

The data path of the file.

string

The optional enum to configure how duplicate files are handled.

string

This is an optional field that should be used to track activity when multiple files are being created. e.g. when you create a single file you don't need it,
but when you create more than one file together, you should use the same event_id for all files. So we can correctly group them into one activity

string

The folderId where the file should be created. When not present, the file will be placed at the root directory.

Headers
json

The HTTP Request-Id request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again. It allows the client and server to correlate each HTTP request. If not provided by the client, the server should generate a unique request ID and include it in the response.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json