Add file to a concept commercial rent contract

Post

/api/v1/contracts/conceptcommercialrent/files

Uploads a file and links it to the concept commercial rent contract.

Add file to a concept commercial rent contract

This endpoint uploads a file and links it to an existing concept commercial lease contract, for example a floor plan or a supporting document for the draft agreement.

A developer calls this endpoint after the concept contract has been created, using its external identifier to attach the file to the correct contract.

Request Fields

Field	Type	Required	Description
externalIdentifier	string	Yes	The identifier of the concept commercial lease contract to attach the file to. This identifier is not generated by Bloxs. Passed as a query parameter.
File	string (binary)	Yes	The file to upload, sent as multipart form data or as a binary-encoded JSON body. The call fails with a 400 response if no file is included.

Response Fields

This endpoint returns no response fields. A successful call confirms the file was created and linked to the contract.

Security

Query parameters

externalIdentifier

stringRequired

The external API identifier of the model.

Body parameters

object

File

string (binary)

Responses

200

The file was created

400

No file was uploaded

404

There was a problem attaching the file to the contract

Expand All

object

type

string | null

title

string | null

traceId

string | null

status

integer (int32)

errors

object | null

property*

Array of string | null additionalProperties

string