[PREVIEW] Add file to a concept private rent contract
  • 24 Dec 2024
  • 1 Minute to read
  • Dark
    Light

[PREVIEW] Add file to a concept private rent contract

  • Dark
    Light

Article summary

Post
/api/v1/contracts/conceptprivaterent/files

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

Description

Adds a file to a concept private rent contract. 

Use Case

The Bloxs user wants to add a file to a concept private rent contract. For example, a floor plan.

Request fields

The request contains the following field:

FieldDescription
externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. This field should contain the externalIdentifier of the estate agent to which the bank accounts belongs.
Security
HTTP
Type Bearer

Please enter a valid token

Query parameters
externalIdentifier
stringRequired

The external API identifier of the model.

Body parameters
object
File
string (binary)
object
File
string (binary)
Responses
200

The file was created

integer (int64)
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