Add file to a concept private rent contract

Post

/api/v1/contracts/conceptprivaterent/files

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

Add file to a concept private rent contract

Uploads a file, such as a floor plan or another supporting document, and links it to a concept residential lease contract.

A developer calls this endpoint while assembling supporting documentation for a draft contract, before the contract is finalized in the Bloxs application.

The file is uploaded as multipart form data, or as a base64-encoded binary value in a JSON body, together with the contract's external identifier as a query parameter.

Request Fields

Field	Type	Required	Description
externalIdentifier	string	Yes	The external identifier of the concept residential lease contract to add the file to. Passed as a query parameter. Assigned by the requesting party, not generated by Bloxs.
File	string (binary)	Yes	The file to upload and link to the concept residential lease contract. Sent as multipart form data, or as a binary value in an application/json body.

Response Fields

This endpoint takes no response fields. A successful call confirms that 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