API ReferenceFiles

Upload Request File (from URL)

Upload a file to a request by providing its URL

Authentication

x-api-keystring
API Key authentication via header

Path parameters

requestIdstringRequired
Request identifier

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
URL of the file to upload
namestringOptional
Name of the file
isArchivedbooleanOptionalDefaults to false
Whether the file is archived
phaseInstanceIdintegerOptional
Optional. The ID of the phase instance to use. If provided, the phase does not need to be started to upload a file. You can gather phase instance ids from the get request endpoint.

Response

Successful response
idinteger
File identifier
namestring
File name
downloadUrlstring
URL to download the file
typestring
File type
updatedAtstringformat: "date-time"
Last update timestamp
createdAtstringformat: "date-time"
Creation timestamp
companyIdinteger
Company identifier
metaDataobject
sourcestring

File source (e.g., INTERNAL)

createdByUserobject
isArchivedboolean or null
Whether the file is archived

Errors