Skip to main content
POST
Create Link

Path Parameters

workspaceId
string
required
projectId
string
required

Body

application/json
name
string
required
Required string length: 1 - 255
requestId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
scope
enum<string>
required
Available options:
project,
project_item,
contact_company
externalUrl
string<uri>
required
Maximum string length: 8192
notes
string
default:""
Maximum string length: 10000
isConfidential
boolean
default:false
phases
enum<string>[]
Maximum array length: 9
Available options:
pre_design,
programming,
schematic_design,
design_development,
construction_documents,
bidding_negotiation,
procurement,
construction_administration,
closeout
documentTypes
enum<string>[]
Maximum array length: 5
Available options:
w9,
coi,
msa,
price_list,
nda
typeId
string | null
itemIds
string[]
Maximum array length: 1000

Response

201 - application/json
id
string
required
projectId
string | null
required
companyId
string | null
required
documentTypes
string[]
required
scope
enum<string>
required
Available options:
project,
project_item,
contact_company
typeId
string | null
required
source
enum<string>
required
Available options:
file,
link
status
enum<string>
required
Available options:
pending,
ready
name
string
required
notes
string
required
isConfidential
boolean
required
phases
enum<string>[]
required
Available options:
pre_design,
programming,
schematic_design,
design_development,
construction_documents,
bidding_negotiation,
procurement,
construction_administration,
closeout
itemIds
string[]
required
externalUrl
string | null
required
originalFilename
string | null
required
mimeType
string | null
required
sizeBytes
number | null
required
createdBy
string | null
required
createdAt
string
required
updatedAt
string
required
version
number
required