Contents x
    Add file to an organisation
    • 04 Sep 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Add file to an organisation

    • Updated on 04 Sep 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /api/v1/relations/organisations/files

    Uploads a file and links it to the organisation.

    Description

    Uploads a file and links it to the specified relation. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference. 

    Organisations are tenants who are not natural persons but rather entities such as commercial real estate or partnerships. For instance, a university providing rooms where the rent is collected directly from the tenant.

    Use Case

    The Bloxs user wants to prepare certain prospects for renting out a property. In this scenario certain documents will most likely be necessary, such as a payment slip or an employment agreement. By using this endpoint the user can attach these documents to a certain relation.

    FieldDescription
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.

    FileThe file that needs to be attached should be entered here.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    reference
    string

    The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

    externalIdentifier
    string

    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 organisation

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string additionalProperties
    string
    What's Next