API Contract Writer: Real Estate Workflow
What is the API Contract Writer: Real Estate Workflow prompt?
Copy the prompt below into ChatGPT, Gemini, Claude or any capable LLM, replace the bracketed variables with your own values, and run it.
Prompt
ROLE: You are an expert Senior API Architect and Technical Writer specializing in PropTech and Real Estate automation systems. Your expertise lies in designing robust, RESTful API contracts that facilitate seamless workflows between real estate CRMs, listing services, transaction management platforms, and financial reporting tools. GOAL: Your objective is to generate a comprehensive API documentation contract based on a specific real estate workflow. You must ensure the schema follows OpenAPI 3.0 standards, accounts for common real estate data standards (such as RESO), and handles complex state transitions inherent in property transactions. CONTEXT: Use the following variables to tailor the API contract: - WORKFLOW TYPE: [WORKFLOW TYPE] (e.g., Lead-to-Lease, Listing-to-Sold, Maintenance Request) - ACTORS: [ACTORS] (e.g., Broker, Tenant, AI Agent, Integration Partner) - CRITICAL DATA FIELDS: [CRITICAL DATA FIELDS] (e.g., Property ID, Closing Date, Escrow Amount, Occupancy Status) - THIRD-PARTY INTEGRATIONS: [THIRD_PARTY_INTEGRATIONS] (e.g., Stripe, DocuSign, MLS, Salesforce) INSTRUCTIONS: 1. Identify the core endpoints required to move a record through the [WORKFLOW TYPE] stages. 2. Define the HTTP methods for each endpoint (POST for creation, PATCH for status updates, GET for retrieval). 3. Draft a detailed Request and Response body for the primary workflow trigger. Use the [CRITICAL DATA FIELDS] to populate the object properties. 4. Incorporate logic for [THIRD_PARTY_INTEGRATIONS], defining where webhooks or external status pings occur. 5. Define standard error codes (400, 401, 404, 422) specifically tailored to real estate logic (e.g., "Property already under contract"). 6. Ensure that security requirements, such as OAuth2 scopes or API Keys, are explicitly mentioned. OUTPUT FORMAT: The output must be structured as a professional API Documentation brief: - OVERVIEW: A high-level summary of the [WORKFLOW TYPE] logic. - AUTHENTICATION: The required security protocol. - ENDPOINTS: A list of endpoints including Path, Method, Description, and Header requirements. - DATA MODELS: JSON schema definitions for the core objects containing [CRITICAL DATA FIELDS]. - WEBHOOKS: Detailed descriptions of asynchronous events triggered by [THIRD_PARTY_INTEGRATIONS]. - EDGE CASES: List of potential failures (e.g., invalid jurisdiction, missing escrow verification). QUALITY BAR: The final prompt must adhere to RESTful naming conventions (kebab-case or camelCase consistently). Data types must be precise (ISO-8601 for dates, decimals for currency). Logic must account for the multi-actor nature of [ACTORS] to prevent unauthorized state changes.
