Attachments: Sample Flow

This article presents a possible use case and corresponding sample flow that you can support. This can be a helpful jumping-off point as you plan your implementation.

Manage documents for real estate properties

In this scenario, you create an app that allows real estate agents to securely upload, manage, and access property-related documents such as contracts, deeds, and inspection reports by attaching them to the relevant client profile on the agent's site.

Flow

To create an app for real estate agents to manage and access property document attachments through their site, follow this basic flow:

  1. Prompt the real esate agent to select a file to upload upon clicking a button.
  2. Call the Generate Attachment Upload Url method to obtain the URL for upload.
  3. Use the generated URL to upload the document as an attachment to the relevant contact profile. Refer to the Upload API for details on how to use the upload URL.
  4. Call the List Attachments method to display a list of all the contact's documents.
  5. When an agent needs to view a specific document, allow them to select it from the list and then call the Get Attachment method to retrieve and display the file.
  6. If the agent needs to delete a file, allow them to select it and then call the Delete Attachment method.
Did this help?