> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Add file to a concept private rent contract
> Uploads a file and links it to the concept private rent contract.
## OpenAPI
````json POST /api/v1/contracts/conceptprivaterent/files
{
"openapi": "3.0.4",
"info": {
"title": "Concept SalesContracts V1",
"description": "Welcome to BETA version of the new Sales Concept Contracts API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "CommercialRentContracts"
},
{
"name": "Concept CommercialRent"
},
{
"name": "Concept PrivateRent"
},
{
"name": "GeneralSalesContracts"
},
{
"name": "Metadata"
},
{
"name": "PrivateRentContracts"
},
{
"name": "SupplierContracts"
}
],
"paths": {
"/api/v1/contracts/conceptprivaterent/files": {
"post": {
"tags": [
"Concept PrivateRent"
],
"summary": "Add file to a concept private rent contract",
"description": "Uploads a file and links it to the concept private rent contract.",
"operationId": "AddFileToConceptPrivateRentContract",
"parameters": [
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"File": {
"style": "form"
}
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"File": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "The file was created"
},
"400": {
"description": "No file was uploaded"
},
"404": {
"description": "There was a problem attaching the file to the contract",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorMessageModel"
}
}
}
}
},
"x-d360-narrative-url": "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.
"
}
}
},
"components": {
"schemas": {
"APIErrorMessageModel": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"traceId": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
````