Developer Documentation
Platform Overview
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Mapping Layers Flexmls: Mapping Shapegen IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: Floor Plans Listings: FloPlans Listings: Historical Listings: History Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals Preferences Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
Supporting Documentation
Terms of Use

Listings: Document Uploads

This service allows the client upload a document using a listing Paired with the Tickets resource for listings or incomplete listings, this service provides a simple interface to submit forms directly to the API from a web browser.

Once uploaded, these are retreived from the Listing Documents resource.

  1. Supported Roles
  2. Available Services
    1. Document Uploads
  3. Response Description
  4. Expansions

Supported Roles

Role Reads Writes Notes
Public No No
Portal No No
Private No Yes

More information about roles may be found here.


Available Services

Document Uploads

URI: Supplied by the Uri attribute in the Listing: Tickets response.

HTTP Method Description Notes
POST Uploads a new document Requires HTTP form based post submissions instead of the standard API JSON body.
GET,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

POST Request


Form Parameter Required Description
Token Yes The upload token granted from the Listing: Tickets service.
Name Yes
Token Yes
File Yes Document file to upload
RedirectTo No URL to send the user back to on successful upload. Optional, JSON response with success message and Id will display by default (See below).
confidentiality Yes Can be:
  • `public` shows the document in all cases.
  • `datashare` shows the document for private and datashare role.
  • `private` shows the document for the private role.
  • `hasedit` shows the document to only agents that can edit listing.

POST Response (Sample)

On success, when RedirectTo is present, the response redirects the user to the URI, otherwise the response contains the Id of the new document.

    "D": {
        "Success": true,
        "Results": [
                "Id": "20120117194139638109000000"

Response Description

Attribute Description Returned for Which User Type(s) Returned for Which API Key Role(s)
Id ID of the uploaded document. All Private