EverReal
  • Introduction
  • Authentication
    • API ClientID and ClientSecret
    • Authentication limitations
  • Rate limiting
  • Helpers
    • Errors
    • Pagination
    • Formatting
  • How to guide
    • EverReal Data Import Process
      • Connect an Integration
      • Import Mappers
      • Ideal CSV Structure
      • Debug Imports
      • FAQ
    • Data import via GraphQL
  • Endpoints
    • Account users / members
    • Owners
      • Owners Query
      • Owners Mutation
    • Property Groups
      • Property Groups Query
      • Property Group Mutation
    • Properties
      • Properties Query
      • Properties Mutation
    • Units
      • Units Query
      • Units Mutation
    • Listing
      • Listing Query
      • Listing Mutation
    • Candidates
      • Candidates Query
      • Candidate Mutation
    • Messages
    • Contact Activites
    • Tenants
      • Tenants Query
      • Tenant Mutation
    • Contract
      • Contract Query
      • Contract Mutation
    • Contacts
      • Contact Mutation
      • Contact Query
    • Document management
      • Document management
      • Simple file upload
    • Tasks
      • Tasks Query
    • Protocols
      • Protocol Query
  • Webhooks
    • Owner Events
      • OWNER_CREATED
      • OWNER_UPDATED
      • OWNER_DELETED
    • Property Events
      • PROPERTY_CREATED
      • PROPERTY_UPDATED
      • PROPERTY_DELETED
    • Unit Events
      • UNIT_CREATED
      • UNIT_UPDATED
      • UNIT_DELETED
    • Listing Events
      • LISTING_ACTIVATED
      • LISTING_ARCHIVED
      • LISTING_UPDATED
      • LISTING_DEACTIVATED
      • LISTING_CREATED
      • LISTING_PUBLISHED_TO_CHANNEL
      • LISTING_UNPUBLISHED_FROM_CHANNEL
    • Candidates Events
      • CANDIDATE_PARSED
      • LISTING_CANDIDATE_APPLIED
    • Listing Contracting Events
      • LISTING_CONTRACT_FLOW_SIGNED
      • LISTING_CONTRACT_FLOW_PARTIALLY_SIGNED
      • LISTING_CONTRACT_FLOW_WITHDRAWN
      • LISTING_CONTRACT_FLOW_STARTED
    • Listing Scheduling Events
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKING_REMOVED_CANDIDATE
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKING_REMOVED_ADMIN
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKED_CANDIDATE
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKED_ADMIN
      • LISTING_CANDIDATE_SCHEDULE_NEW_TIMESLOTS_REQUESTED
      • LISTING_CANDIDATE_SCHEDULE_INVITED_VIEWING
    • Protocol Events
      • PROTOCOL_COMPLETED
  • Change log
    • Releases
      • Introducing Mappers
      • Enhancements for GraphQL
      • Enhancements for Querying
      • Enhancements for Webhooks
    • Upcoming
      • Introduced Querying Protocol in GraphQL
Powered by GitBook
On this page

Was this helpful?

  1. Endpoints

Document management

Uploading files and documents into EverReal

Introduction

EverReal provides 2 ways to upload files.

  1. Uploading a document that can be linked to various entities directly.

  2. Uploading a file for later use that can be transformed to a document later or can be used for other data sources, like linking it to a listing.

Most common scenarios

  • For uploading documents to properties and units, please use the Document management page.

  • For uploading files for listings please use the Simple file upload page.

Important to know

  • All files uploaded to your account are tracked and are subject to extra cost if the account file size exceeds 10GB

  • Maximum file size allowed to be uploaded is 20MB

  • We don't support uploading in chunks for bigger file sizes - yet

  • Images are resized automatically for storage optimisation to a maximum size /or width of 2500px.

  • A relative path needs to be passed for every upload as resourcePath property and we will return the final resourcePath with the company namespace appended to it, similar to something like: subdomain/{accountUniqueIdentifier}/{resourcePath}.

    • for documents we also append the document id at the end, so the final resourcePath will look like subdomain/{accountUniqueIdentifier}/{resourcePath}/{documentId}

  • To get the complete URL to the file, you should append one of these urls:

    • https://resources.everreal.co/returnedResourcePath for production environment

    • https://qa.resources.everreal.co/returnedResourcePath for staging environment

  • We don't provide an "update" endpoint, because the CDN will cache the resources, thus we recommend always creating a new file and to delete the old one. The CDN cache is between 1h to 24h.

GDPR

  • All files are stored in AWS S3 and encrypted on bucket level and only we, as EverReal have access to it.

PreviousContact QueryNextDocument management

Last updated 1 year ago

Was this helpful?