---
title: "Matchai documentation"
description: "Matchai documentation: how the AI workspace for real estate professionals works, and how developers can build on it."
lang: "en"
canonical: "https://matchai.co/docs"
---

# Matchai documentation

> Matchai documentation: how the AI workspace for real estate professionals works, and how developers can build on it.

## Guide

For real estate professionals. Listings, your website, contacts, messaging, the Matchai Assistant and more.

- [Welcome to Matchai](https://matchai.co/docs/guide.md): What Matchai is, who it is for and what you can do with it. Start here if you are new to Matchai.
- [Create your account](https://matchai.co/docs/guide/getting-started/create-your-account.md): Sign up with Google, Apple, Microsoft, your email or your mobile number, choose a regular or professional account, and sign out or delete it.
- [Set up your profile](https://matchai.co/docs/guide/getting-started/set-up-your-profile.md): Add your photo, name, bio, social profiles and professional details, choose your username, and see where each one appears.
- [Install the app](https://matchai.co/docs/guide/getting-started/install-the-app.md): Add Matchai to your iPhone, iPad, Android phone or computer as an app, with no app store, and turn on push notifications.
- [Language and appearance](https://matchai.co/docs/guide/getting-started/language-and-appearance.md): Use Matchai in English, French (Canada) or Spanish, choose a system, light or dark theme, and adjust your calendar and navigation.
- [Listings](https://matchai.co/docs/guide/listings.md): What a listing is on Matchai, how it moves from draft to published, and where your published listings appear.
- [Create a listing](https://matchai.co/docs/guide/listings/create-a-listing.md): Turn photos, an address and a price into a complete draft listing written with AI, then review it before you publish.
- [Import from a website](https://matchai.co/docs/guide/listings/import-from-a-website.md): Copy a listing you already have on Centris, Realtor.ca, Zillow or another website into Matchai, with its details and photos.
- [Photos and media](https://matchai.co/docs/guide/listings/photos-and-media.md): Upload and order a listing's photos, choose the cover, lay out the page, add neighbourhood photos, a virtual tour and videos.
- [Location](https://matchai.co/docs/guide/listings/location.md): Set or change a listing's address and map, see what visitors see, and write the neighbourhood description.
- [Price and details](https://matchai.co/docs/guide/listings/price-and-details.md): Set a listing's price, currency and rental period, choose ft² or m², describe its rooms and spaces, and add its features.
- [Publish and visibility](https://matchai.co/docs/guide/listings/publish-and-visibility.md): Publish a listing, preview a draft, change its web address, mark it as sold, unpublish, archive or delete it.
- [Listing analytics](https://matchai.co/docs/guide/listings/listing-analytics.md): See who viewed a listing, where they came from, what they clicked, and when an AI assistant read, recommended or showed it, with the proof.
- [Your listings in AI search](https://matchai.co/docs/guide/listings/listings-in-ai-search.md): How Matchai makes your published listings easy for Google, ChatGPT, Claude, Gemini and Perplexity to find and cite, what helps, and what stays private.
- [Listings in several languages](https://matchai.co/docs/guide/listings/listings-in-several-languages.md): Your listings are translated into English, French and Spanish automatically. Check a translation, write your own wording, or fix the original language.
- [Your online presence](https://matchai.co/docs/guide/online-presence.md): Your Matchai Site, your Matchai Page and your business card. What each one is, how they differ and which one to share when.
- [Your Matchai Site](https://matchai.co/docs/guide/online-presence/matchai-site.md): Create your own website of listings at yourname.matchai.co, publish it, change its address and share it with clients.
- [Use your own domain](https://matchai.co/docs/guide/online-presence/custom-domain.md) (in closed beta): Show your Matchai Site at an address you own. Buy a new domain or connect yours, add one record, and choose the address visitors see.
- [Your Matchai Page](https://matchai.co/docs/guide/online-presence/matchai-page.md): One page at yourname.matchai.pro for your social bios, with your photo, social profiles, links, files and listings, and a way to book you.
- [Your business card](https://matchai.co/docs/guide/online-presence/business-card.md): A digital business card with a QR code. People scan it, save your contact in one tap and can share their own contact back.
- [Studio](https://matchai.co/docs/guide/studio.md) (in closed beta): Turn a listing's photos into a short video for the top of the listing page, and sharpen, retouch or virtually stage the photos themselves.
- [Photos and video](https://matchai.co/docs/guide/studio/photos-and-video.md) (in closed beta): Make a hero video from a listing's photos, change its length, quality and phone framing, edit it, and sharpen or retouch photos.
- [AI staging](https://matchai.co/docs/guide/studio/ai-staging.md) (in closed beta): Furnish an empty room in a listing photo, compare it with the original, and add it to your listing with a "Virtually staged" label.
- [Contacts](https://matchai.co/docs/guide/contacts.md): Your leads, clients and peers in one place. Where contacts come from, how to add someone, and what each person can and cannot see.
- [Lead pipeline](https://matchai.co/docs/guide/contacts/lead-pipeline.md) (in closed beta): See every lead's priority, warmth, stage, budget and next step in one table, edit them yourself or let Matchai fill them in from your conversations.
- [Converting a contact](https://matchai.co/docs/guide/contacts/converting-a-contact.md): Turn a lead into a client when they are ready to work with you, or a client back into a lead. Their conversation and history move with them.
- [Messaging](https://matchai.co/docs/guide/messaging.md): Talk with your leads, clients, peers, teams and projects in one place. Share photos and files, reply, edit, search, and report or block someone.
- [Reactions and GIFs](https://matchai.co/docs/guide/messaging/reactions-and-gifs.md): React to a message with an emoji, add emoji to what you write, and send a GIF, in any conversation.
- [Online status and typing](https://matchai.co/docs/guide/messaging/presence-and-typing.md): A green dot shows who is online right now, and a typing indicator shows when someone is writing to you. What each one means, and why.
- [Guest conversations](https://matchai.co/docs/guide/messaging/guest-conversations.md): How a visitor with no Matchai account messages you from a listing, your Matchai Site or your Matchai Page, and how they become one of your leads.
- [Your calendar](https://matchai.co/docs/guide/calendar.md): See your appointments by day, week or month, answer requests, and connect Google Calendar so the times you are busy there are never booked.
- [Your availability](https://matchai.co/docs/guide/calendar/availability.md): Set your weekly hours and date overrides, choose when each listing can be shown, and see how visitors pick an open time.
- [Appointments and viewings](https://matchai.co/docs/guide/calendar/appointments-and-viewings.md): How buyers request viewings, how you accept, decline or reschedule, who takes part, who is notified, and what happens when someone cancels.
- [Matchai Assistant](https://matchai.co/docs/guide/assistant.md) (in closed beta): What the Matchai Assistant does in your workspace, how to talk to it, what it costs, and what it never does without asking you first.
- [Assistant memory](https://matchai.co/docs/guide/assistant/memory.md) (in closed beta): What the Matchai Assistant remembers about how you work, what it never keeps, and how to read, edit, undo or delete its memory.
- [Skills](https://matchai.co/docs/guide/assistant/skills.md) (in closed beta): Save something you do often as steps the Matchai Assistant follows, then run it any time by typing a slash and its name.
- [Approvals](https://matchai.co/docs/guide/assistant/approvals.md) (in closed beta): Which actions the Matchai Assistant asks you about first, what you can let it do on its own, why final buttons always ask, and how to undo.
- [Talk to the assistant](https://matchai.co/docs/guide/assistant/voice.md) (in closed beta): Dictate messages to the Matchai Assistant, go hands-free while you drive, and what Matchai keeps when you speak instead of typing.
- [Websites](https://matchai.co/docs/guide/assistant/websites.md) (in closed beta): Let the Matchai Assistant work on other websites for you, in your own browser, while you watch. What it needs, what it does, and what always asks.
- [Workflows](https://matchai.co/docs/guide/workflows.md) (in closed beta): Automations that run on their own. A lead email arrives, Matchai reads the lead out of it and adds the contact to HubSpot.
- [Build a workflow](https://matchai.co/docs/guide/workflows/build-a-workflow.md) (in closed beta): Lay out a workflow on the canvas, connect its steps, try it with a sample email, then turn it on and follow every run.
- [Triggers and actions](https://matchai.co/docs/guide/workflows/triggers-and-actions.md) (in closed beta): The trigger and actions that run in a workflow today, what each one needs and uses, and what you may see in the builder that is not available yet.
- [Matchai Cloud](https://matchai.co/docs/guide/cloud.md): Every file for every deal, already filed by listing, contact, team and project. Private by default, at your own address on matchai.cloud.
- [Sharing and drop links](https://matchai.co/docs/guide/cloud/sharing-and-drop-links.md): Who can see your Cloud files, how to publish a document on a listing page, and how to collect files from a notary or client who has no account.
- [Teams and projects](https://matchai.co/docs/guide/teams-and-projects.md): Work with other professionals. A team is the group you work with every day. A project is one deal, with its people, listings and chats.
- [Teams](https://matchai.co/docs/guide/teams-and-projects/teams.md): Create a team, invite your colleagues by name or with a link, talk in the team chat, and share projects and listings with the whole team.
- [Projects](https://matchai.co/docs/guide/teams-and-projects/projects.md): Give each deal its own space, with the people on it, its listings, the teams working on it, and chats organised in sections.
- [Roles and permissions](https://matchai.co/docs/guide/teams-and-projects/roles-and-permissions.md): What an owner, an admin and a member can do in a team or a project, how to change a role, how ownership changes hands, and what a team owns.
- [Matchai Energy](https://matchai.co/docs/guide/energy-and-billing.md): What Matchai Energy is, what uses it, how your Energy is shown, your free daily dose, and what happens when you run low.
- [Matchai Store](https://matchai.co/docs/guide/energy-and-billing/matchai-store.md): Buy Matchai Energy as a Small box, a Bag or a Box, and manage your payment method, invoices, refunds and subscriptions in Billing.
- [Gifting Energy](https://matchai.co/docs/guide/energy-and-billing/gifting-energy.md): Give an unopened Small box, Bag or Box of Matchai Energy to another professional on Matchai, and what they see when it arrives.
- [Matchai Connectors](https://matchai.co/docs/guide/connectors.md): Connect Google Calendar and other services to Matchai, what each connector lets Matchai do, what it costs, and how to disconnect it.
- [Notifications](https://matchai.co/docs/guide/notifications.md): What Matchai tells you about, where you see it, how to act on a notification, and how to turn push notifications on or off.
- [Matchai for Chrome](https://matchai.co/docs/guide/chrome-extension.md) (in closed beta): The Matchai Chrome extension lets your assistant work on other websites in your own browser. How to install it, what it reads, and how to remove it.
- [Privacy and security](https://matchai.co/docs/guide/privacy-and-security.md): What is private and what is public in Matchai, who can see your records, how AI features use your data, and how to delete your account.
- [Frequently asked questions](https://matchai.co/docs/guide/faq.md): Quick answers about signing in, invitations, notifications, showings, Matchai Energy, connectors, Matchai Cloud, privacy and deleting your account.

## Developers

For website builders and integrators. The Matchai MCP server, listing search and the Matchai API.

- [Build on Matchai](https://matchai.co/docs/developers.md): Read Matchai listings today with the MCP server, listing search and AI-readable pages, no key needed. The Matchai API, API keys and webhooks are coming soon.
- [Quickstart](https://matchai.co/docs/developers/quickstart.md) (coming soon): Create an API key, call GET /v1/me, list your listings and add a contact with curl, JavaScript or Python. The Matchai API is coming soon.
- [Authentication](https://matchai.co/docs/developers/authentication.md) (coming soon): Two ways to call the Matchai API: API keys for your own account, and Connect with Matchai (OAuth 2.1) for apps. Scopes, final actions and Energy limits.
- [API keys](https://matchai.co/docs/developers/authentication/api-keys.md) (coming soon): Create a scoped API key for your own Matchai account, use it as a bearer token, keep it safe, rotate it and revoke it. For your own scripts and AI tools only.
- [Create a Matchai app](https://matchai.co/docs/developers/authentication/create-a-matchai-app.md) (coming soon): Register the app professionals connect to with Connect with Matchai: name, logo, website, redirect URLs, client ID and secret, free test mode and who pays.
- [Connect with Matchai](https://matchai.co/docs/developers/authentication/connect-with-matchai.md) (coming soon): Let a professional connect their Matchai account to your app with OAuth 2.1 and PKCE. Endpoints, the Allow page, tokens and a full TypeScript example.
- [MCP server](https://matchai.co/docs/developers/mcp-server.md): Connect an AI assistant to the Matchai MCP server to search published listings. Endpoints, transport, limits, and setup for Claude, ChatGPT and other clients.
- [Public tools](https://matchai.co/docs/developers/mcp-server/public-tools.md): Reference for the Matchai MCP tools search_listings, get_listing and get_professional. Inputs, outputs, examples and the listing-card widget.
- [Authenticated tools](https://matchai.co/docs/developers/mcp-server/authenticated-tools.md) (coming soon): Connect Claude or ChatGPT to your own Matchai account with one click. Planned personal tools for listings, contacts, messages and calendar, with approvals.
- [Listing search](https://matchai.co/docs/developers/listing-search.md): Search published Matchai listings in natural language with the /ask endpoint (NLWeb). Parameters, response shape, host-aware scope, limits and examples.
- [AI-readable pages](https://matchai.co/docs/developers/agent-readable-pages.md): How every public Matchai site describes itself to AI assistants and crawlers, from llms.txt to Markdown copies and JSON-LD. Mirror it on your own site.
- [Webhooks](https://matchai.co/docs/developers/webhooks.md) (coming soon): Get signed events when a lead arrives, a visit is booked or a listing changes. Event catalog, payload, signature check, retries, testing and delivery logs.
- [Website builders](https://matchai.co/docs/developers/guides/website-builders.md): Show a broker's Matchai listings on sites you build, today with no key. The partner kit for feeds, leads, viewings and webhooks is coming soon.
- [AI assistants](https://matchai.co/docs/developers/guides/ai-assistants.md): Connect Claude, ChatGPT or your own assistant to Matchai. Search published listings today with no account. Personal tools and API keys are coming soon.
- [API reference](https://matchai.co/docs/developers/api-reference.md) (coming soon): The planned Matchai API: base URL, authentication, pagination, idempotency, request ids and how to read the Coming soon badges. Download the OpenAPI file.
- [Get the connected account](https://matchai.co/docs/developers/api-reference/me/getMe.md) (coming soon): Returns the Matchai account this key or token acts for: profile, language, time zone, site and page, and the state of its Matchai Energy (never a number).
- [Update the profile](https://matchai.co/docs/developers/api-reference/me/updateMe.md) (coming soon): Changes profile fields: name, biography, job title, public work email and phone, time zone, language and social links.
- [Get this connection](https://matchai.co/docs/developers/api-reference/me/getConnection.md) (coming soon): Describes the connection your credentials belong to: the app, the scopes granted, whether final actions ask first (ask_me) or run straight away (allowed),…
- [Disconnect this app](https://matchai.co/docs/developers/api-reference/me/disconnect.md) (coming soon): Ends the connection between this app and the account, as if the account holder pressed Disconnect on the Connectors page.
- [Look up a professional](https://matchai.co/docs/developers/api-reference/professionals/getProfessional.md) (coming soon): Returns the public profile of a professional by their handle: name, headline, agency, professions, socials and the addresses of their Matchai Site and…
- [List a professional’s published listings](https://matchai.co/docs/developers/api-reference/professionals/listProfessionalListings.md) (coming soon): Returns the listings a professional has published, newest first.
- [Get one published listing](https://matchai.co/docs/developers/api-reference/professionals/getProfessionalListing.md) (coming soon): Returns one published listing with its photos. Returns 404 for a draft or an archived listing.
- [List your listings](https://matchai.co/docs/developers/api-reference/listings/listListings.md) (coming soon): Returns the listings you can manage — yours and your teams’ — most recently changed first.
- [Create a listing](https://matchai.co/docs/developers/api-reference/listings/createListing.md) (coming soon): Creates a draft listing from the fields you give.
- [Get a listing](https://matchai.co/docs/developers/api-reference/listings/getListing.md) (coming soon): Returns one listing you can manage. With locale, text fields come back translated when a translation exists.
- [Update a listing](https://matchai.co/docs/developers/api-reference/listings/updateListing.md) (coming soon): Changes the fields you send and nothing else.
- [Delete a listing](https://matchai.co/docs/developers/api-reference/listings/deleteListing.md) (coming soon): Deletes the listing and takes it off every site. Its address on the web becomes free again. To take it off the market but keep it, archive it instead.
- [Publish a listing](https://matchai.co/docs/developers/api-reference/listings/publishListing.md) (coming soon): Puts the listing on the public web, and on your own Matchai Site. Publishing an archived listing restores it.
- [Unpublish a listing](https://matchai.co/docs/developers/api-reference/listings/unpublishListing.md) (coming soon): Turns the listing back into a draft: it disappears from the public web and from every site.
- [Archive a listing](https://matchai.co/docs/developers/api-reference/listings/archiveListing.md) (coming soon): Takes the listing off the market. Nothing is deleted, and publishing it again puts it back. It changes no other field.
- [Search addresses](https://matchai.co/docs/developers/api-reference/listings/searchAddresses.md) (coming soon): Suggests real addresses for what someone typed.
- [Move a listing to an address](https://matchai.co/docs/developers/api-reference/listings/setListingAddress.md) (coming soon): Sets the listing’s address and map location from an address_id. A wrong id moves the listing to the wrong building, so only pass one the person chose.
- [Create a listing with AI](https://matchai.co/docs/developers/api-reference/listings/createListingGeneration.md) (coming soon): Starts AI listing creation, the same as Create listing in the app.
- [Get a listing creation run](https://matchai.co/docs/developers/api-reference/listings/getListingGeneration.md) (coming soon): Returns where an AI listing creation run stands, and the draft listing once it is done.
- [List photos and videos](https://matchai.co/docs/developers/api-reference/listings/listListingMedia.md) (coming soon): Returns the listing’s photos and videos in gallery order. The first one is the cover.
- [Add a photo or video](https://matchai.co/docs/developers/api-reference/listings/addListingMedia.md) (coming soon): Adds one photo or video at the end of the gallery, either uploaded (multipart/form-data) or copied from a public URL (application/json).
- [Reorder photos](https://matchai.co/docs/developers/api-reference/listings/reorderListingMedia.md) (coming soon): Puts the gallery in a new order. Send every current media id: this never adds or removes media, and a list that does not match the gallery is refused with 422.
- [Set the cover or move a photo](https://matchai.co/docs/developers/api-reference/listings/updateListingMedia.md) (coming soon): Makes a photo the cover (it moves first), or moves it to another part of the listing page. The two page breaks hold three photos each at most.
- [Remove a photo or video](https://matchai.co/docs/developers/api-reference/listings/deleteListingMedia.md) (coming soon): Removes the photo or video from the listing.
- [Restore the original photo](https://matchai.co/docs/developers/api-reference/listings/restoreOriginalMedia.md) (coming soon): Puts back the photo as it was before an edit replaced it. Pass the photo that is on the listing now.
- [Edit or stage a photo with AI](https://matchai.co/docs/developers/api-reference/listings/createPhotoEdit.md) (coming soon): Makes an edited version of one photo: declutter, a new sky, relighting, a time of day, a season, a mood, virtual staging, a sharper upscale, or a change you…
- [Get a photo edit](https://matchai.co/docs/developers/api-reference/listings/getPhotoEdit.md) (coming soon): Returns where a photo edit stands, with a preview once it succeeded.
- [Put an edited photo on the listing](https://matchai.co/docs/developers/api-reference/listings/applyPhotoEdit.md) (coming soon): Adds the edited photo next to the original (add), or replaces the original with it (replace). A replaced original can be restored later.
- [List rooms](https://matchai.co/docs/developers/api-reference/listings/listListingSpaces.md) (coming soon): Returns the rooms and spaces of the property, in page order.
- [Add a room](https://matchai.co/docs/developers/api-reference/listings/addListingSpace.md) (coming soon): Adds a room, with its size and floor when you know them. Adding a bedroom or a bathroom raises the listing’s count to match.
- [Rename or resize a room](https://matchai.co/docs/developers/api-reference/listings/updateListingSpace.md) (coming soon): Changes a room’s name, floor, size, flooring or note. Leave out dimension_unit to keep the room’s unit.
- [Remove a room](https://matchai.co/docs/developers/api-reference/listings/deleteListingSpace.md) (coming soon): Removes a room from the listing. Removing a bedroom or a bathroom lowers the listing’s count to match.
- [List room types](https://matchai.co/docs/developers/api-reference/listings/listSpaceTypes.md) (coming soon): Returns every room and space type you can add, with the key to send as type.
- [List a listing’s documents](https://matchai.co/docs/developers/api-reference/listings/listListingDocuments.md) (coming soon): Returns the Matchai Cloud documents filed on this listing. Those with visibility: public are shown on the public listing page.
- [File a document on a listing](https://matchai.co/docs/developers/api-reference/listings/addListingDocument.md) (coming soon): Files an existing document on this listing. It stays private until you make it public with PUT /documents/{document_id}/visibility.
- [Take a document off a listing](https://matchai.co/docs/developers/api-reference/listings/removeListingDocument.md) (coming soon): Takes the document off this listing.
- [Get a listing’s translation](https://matchai.co/docs/developers/api-reference/listings/getListingTranslations.md) (coming soon): Returns the listing’s text in one language, field by field, with whether each was translated automatically or written by hand, and whether the original…
- [Translate a listing](https://matchai.co/docs/developers/api-reference/listings/translateListing.md) (coming soon): Translates the listing’s title, description, highlights and neighbourhood text into the languages you name.
- [Go back to automatic translation](https://matchai.co/docs/developers/api-reference/listings/clearListingTranslation.md) (coming soon): Drops your hand-written translation of one field, so automatic translation takes it over again.
- [Write a translation by hand](https://matchai.co/docs/developers/api-reference/listings/setListingTranslation.md) (coming soon): Saves your own translation of one field. Automatic translation leaves it alone from then on.
- [Get a listing’s visit hours](https://matchai.co/docs/developers/api-reference/availability-and-appointments/getListingAvailability.md) (coming soon): Returns whether visits can be booked from this listing, the visit lengths offered, and the showing hours.
- [Set a listing’s visit hours](https://matchai.co/docs/developers/api-reference/availability-and-appointments/setListingAvailability.md) (coming soon): Replaces the listing’s visit settings.
- [Get your availability](https://matchai.co/docs/developers/api-reference/availability-and-appointments/getAvailability.md) (coming soon): Returns your weekly hours and whether people can book time with you.
- [Set your availability](https://matchai.co/docs/developers/api-reference/availability-and-appointments/setAvailability.md) (coming soon): Changes your time zone, whether you accept bookings, or your weekly hours. weekly_hours replaces every weekly entry.
- [List days off and special hours](https://matchai.co/docs/developers/api-reference/availability-and-appointments/listAvailabilityOverrides.md) (coming soon): Returns one-day exceptions to your weekly hours, earliest first.
- [Add a day off or special hours](https://matchai.co/docs/developers/api-reference/availability-and-appointments/createAvailabilityOverride.md) (coming soon): Adds a one-day exception. Appointments already booked that day are not changed.
- [Remove a day off or special hours](https://matchai.co/docs/developers/api-reference/availability-and-appointments/deleteAvailabilityOverride.md) (coming soon): Removes a one-day exception; your weekly hours apply that day again.
- [Find your free slots](https://matchai.co/docs/developers/api-reference/availability-and-appointments/listAvailableSlots.md) (coming soon): Returns the times you are free on one day for an appointment of this length: your hours, minus your appointments and the busy times of a connected calendar.
- [Find bookable slots](https://matchai.co/docs/developers/api-reference/availability-and-appointments/listPublicBookingSlots.md) (coming soon): Returns the times anyone can book with this professional on one day — the same times their listing pages and Matchai Page offer.
- [Request a visit for a website visitor](https://matchai.co/docs/developers/api-reference/availability-and-appointments/requestViewing.md) (coming soon): Records a visit request made on your website.
- [List appointment types](https://matchai.co/docs/developers/api-reference/availability-and-appointments/listAppointmentTypes.md) (coming soon): Returns every appointment type with its name.
- [List appointments](https://matchai.co/docs/developers/api-reference/availability-and-appointments/listAppointments.md) (coming soon): Returns appointments in a time range, earliest first. status=requested lists what waits on the account holder’s answer.
- [Book an appointment](https://matchai.co/docs/developers/api-reference/availability-and-appointments/bookAppointment.md) (coming soon): Books a visit or a meeting in your calendar and invites the participants.
- [Get an appointment](https://matchai.co/docs/developers/api-reference/availability-and-appointments/getAppointment.md) (coming soon): Returns one appointment.
- [Update an appointment](https://matchai.co/docs/developers/api-reference/availability-and-appointments/updateAppointment.md) (coming soon): Changes the title, your private notes or the directions. It notifies nobody.
- [Confirm a request](https://matchai.co/docs/developers/api-reference/availability-and-appointments/confirmAppointment.md) (coming soon): Accepts a requested appointment. The person who asked is told.
- [Decline a request](https://matchai.co/docs/developers/api-reference/availability-and-appointments/declineAppointment.md) (coming soon): Declines a requested appointment. The person who asked is told.
- [Reschedule an appointment](https://matchai.co/docs/developers/api-reference/availability-and-appointments/rescheduleAppointment.md) (coming soon): Moves an appointment to a new time. When someone else is on it, it proposes the time instead (reschedule_pending), and nothing moves until they accept.
- [Accept a proposed time](https://matchai.co/docs/developers/api-reference/availability-and-appointments/acceptReschedule.md) (coming soon): Accepts the new time someone proposed. The appointment moves and everyone is told.
- [Decline a proposed time](https://matchai.co/docs/developers/api-reference/availability-and-appointments/declineReschedule.md) (coming soon): Declines the proposed time. The appointment keeps its original time.
- [Cancel an appointment](https://matchai.co/docs/developers/api-reference/availability-and-appointments/cancelAppointment.md) (coming soon): Cancels the appointment and tells every participant.
- [List your sites](https://matchai.co/docs/developers/api-reference/sites/listSites.md) (coming soon): Returns the Matchai Sites you can manage: your own and your teams’. A professional has one site of their own.
- [Create a site](https://matchai.co/docs/developers/api-reference/sites/createSite.md) (coming soon): Creates a Matchai Site at {subdomain}.matchai.co, unpublished. Your published listings are added to it.
- [Get a site](https://matchai.co/docs/developers/api-reference/sites/getSite.md) (coming soon): Returns one site.
- [Update a site](https://matchai.co/docs/developers/api-reference/sites/updateSite.md) (coming soon): Changes the site’s name, tagline, description, top image, contact details or socials. A published site updates straight away.
- [Publish a site](https://matchai.co/docs/developers/api-reference/sites/publishSite.md) (coming soon): Puts the site on the public web.
- [Unpublish a site](https://matchai.co/docs/developers/api-reference/sites/unpublishSite.md) (coming soon): Takes the site off the public web. Your listings stay published on their own pages.
- [List a site’s listings](https://matchai.co/docs/developers/api-reference/sites/listSiteListings.md) (coming soon): Returns the listings on the site, in site order, with which are featured.
- [Reorder a site’s listings](https://matchai.co/docs/developers/api-reference/sites/reorderSiteListings.md) (coming soon): Puts the site’s listings in a new order. Send every listing on the site.
- [Take a listing off a site](https://matchai.co/docs/developers/api-reference/sites/removeSiteListing.md) (coming soon): Takes the listing off this site. It stays published on its own page. To take it off the web entirely, unpublish the listing.
- [Add a listing to a site, or feature it](https://matchai.co/docs/developers/api-reference/sites/putSiteListing.md) (coming soon): Puts a published listing on the site, or changes whether it is featured. Taking a listing off a site changes nothing about the listing itself.
- [Get your Matchai Page](https://matchai.co/docs/developers/api-reference/page/getPage.md) (coming soon): Returns your Matchai Page, including hidden links and an unpublished page.
- [Update your Matchai Page](https://matchai.co/docs/developers/api-reference/page/updatePage.md) (coming soon): Changes the headline, and whether visitors can book time with you from the page.
- [Publish your Matchai Page](https://matchai.co/docs/developers/api-reference/page/publishPage.md) (coming soon): Puts the page on the public web at {username}.matchai.pro. Returns 422 handle_not_routable when the username cannot be a web address yet.
- [Unpublish your Matchai Page](https://matchai.co/docs/developers/api-reference/page/unpublishPage.md) (coming soon): Takes the page off the public web. Nothing on it is deleted.
- [List your page links](https://matchai.co/docs/developers/api-reference/page/listPageLinks.md) (coming soon): Returns the links on your page, in order, with their click counts.
- [Add a link](https://matchai.co/docs/developers/api-reference/page/createPageLink.md) (coming soon): Adds a link at the end of the page. It shows on the public page straight away when the page is published.
- [Reorder your links](https://matchai.co/docs/developers/api-reference/page/reorderPageLinks.md) (coming soon): Puts the links in a new order. Send every link id.
- [Update a link](https://matchai.co/docs/developers/api-reference/page/updatePageLink.md) (coming soon): Changes a link’s title or address, or hides it.
- [Delete a link](https://matchai.co/docs/developers/api-reference/page/deletePageLink.md) (coming soon): Deletes the link and its click count. To keep it for later, hide it instead.
- [Show a file on your page](https://matchai.co/docs/developers/api-reference/page/addPageFile.md) (coming soon): Shows a Matchai Cloud document on your page, where anyone who opens the page can download it.
- [Take a file off your page](https://matchai.co/docs/developers/api-reference/page/removePageFile.md) (coming soon): Takes the file off your page. The document stays in Matchai Cloud.
- [List contacts](https://matchai.co/docs/developers/api-reference/contacts/listContacts.md) (coming soon): Returns your contacts, newest first. query searches every contact by name and company; all its words must match.
- [Add a contact](https://matchai.co/docs/developers/api-reference/contacts/createContact.md) (coming soon): Adds a lead, a client or a professional to your contacts.
- [Get a contact](https://matchai.co/docs/developers/api-reference/contacts/getContact.md) (coming soon): Returns one contact with its lead, client or professional details.
- [Update a contact](https://matchai.co/docs/developers/api-reference/contacts/updateContact.md) (coming soon): Changes the details you keep about a contact. What you type here never changes the person’s own Matchai profile.
- [Delete a contact](https://matchai.co/docs/developers/api-reference/contacts/deleteContact.md) (coming soon): Deletes the contact record and its pipeline details. Conversations with the person are not deleted.
- [Convert a contact](https://matchai.co/docs/developers/api-reference/contacts/convertContact.md) (coming soon): Moves a contact along the path lead → client → professional, keeping their history.
- [Get lead details](https://matchai.co/docs/developers/api-reference/contacts/getLeadDetails.md) (coming soon): Returns where a lead stands in your pipeline: stage, temperature, readiness, budget, timeline and what they are looking for.
- [Update lead details](https://matchai.co/docs/developers/api-reference/contacts/updateLeadDetails.md) (coming soon): Moves a lead through your pipeline or records their budget and preferences.
- [List what a contact saved](https://matchai.co/docs/developers/api-reference/contacts/listContactSavedListings.md) (coming soon): Returns your listings this contact saved, most recent first.
- [Send a website enquiry](https://matchai.co/docs/developers/api-reference/contacts/createEnquiry.md) (coming soon): Records a message someone left on your website.
- [List conversations](https://matchai.co/docs/developers/api-reference/conversations-and-messages/listConversations.md) (coming soon): Returns your conversations, most recent activity first, with who wrote last and how many messages are unread.
- [Start a conversation](https://matchai.co/docs/developers/api-reference/conversations-and-messages/createConversation.md) (coming soon): Opens a conversation with a contact, or invites someone who is not on Matchai by email or by a link you pass on, and sends first_message.
- [Get a conversation](https://matchai.co/docs/developers/api-reference/conversations-and-messages/getConversation.md) (coming soon): Returns one conversation.
- [Archive a conversation](https://matchai.co/docs/developers/api-reference/conversations-and-messages/archiveConversation.md) (coming soon): Moves the conversation out of your list. Only you see the change, and a new message brings it back.
- [Unarchive a conversation](https://matchai.co/docs/developers/api-reference/conversations-and-messages/unarchiveConversation.md) (coming soon): Puts the conversation back in your list.
- [Mark a conversation as read](https://matchai.co/docs/developers/api-reference/conversations-and-messages/markConversationRead.md) (coming soon): Marks every message in the conversation as read by you.
- [List participants](https://matchai.co/docs/developers/api-reference/conversations-and-messages/listParticipants.md) (coming soon): Returns everyone in the conversation.
- [Add someone to a group conversation](https://matchai.co/docs/developers/api-reference/conversations-and-messages/addParticipant.md) (coming soon): Adds one of your contacts to a group conversation you own or administer. They are notified and can read its history.
- [List messages](https://matchai.co/docs/developers/api-reference/conversations-and-messages/listMessages.md) (coming soon): Returns the conversation’s messages, newest first. Reading them does not mark them as read.
- [Send a message](https://matchai.co/docs/developers/api-reference/conversations-and-messages/sendMessage.md) (coming soon): Sends a message, with files if you like, in the account holder’s name.
- [Edit a message](https://matchai.co/docs/developers/api-reference/conversations-and-messages/editMessage.md) (coming soon): Changes the text of a message the account sent. Everyone sees that it was edited. A message that went out by text cannot be edited.
- [Delete a message](https://matchai.co/docs/developers/api-reference/conversations-and-messages/deleteMessage.md) (coming soon): Deletes a message the account sent, for everyone in the conversation.
- [Draft a reply with AI](https://matchai.co/docs/developers/api-reference/conversations-and-messages/draftReply.md) (coming soon): Writes a reply for a person to review, from what they want to say. It sends nothing; send the reviewed text with POST /conversations/{conversation_id}/messages.
- [Search messages](https://matchai.co/docs/developers/api-reference/conversations-and-messages/searchMessages.md) (coming soon): Finds messages containing these words, across every conversation you are in, best match first.
- [List sent emails](https://matchai.co/docs/developers/api-reference/conversations-and-messages/listEmails.md) (coming soon): Returns the emails Matchai sent in the account holder’s name, and whether each arrived.
- [Email a contact](https://matchai.co/docs/developers/api-reference/conversations-and-messages/sendEmail.md) (coming soon): Sends an email from Matchai to one of your contacts, in the account holder’s name, with up to three documents attached.
- [Draft an email with AI](https://matchai.co/docs/developers/api-reference/conversations-and-messages/draftEmail.md) (coming soon): Writes an email to a contact for a person to review. It sends nothing.
- [List documents](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/listDocuments.md) (coming soon): Returns the Matchai Cloud documents you can open, newest first.
- [Upload a document](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/uploadDocument.md) (coming soon): Uploads a file to Matchai Cloud, private, and optionally files it in one place. Matchai reads its text so it can be searched and summarised.
- [Get a document](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/getDocument.md) (coming soon): Returns one document with a short-lived download_url.
- [Move a document to the trash](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/trashDocument.md) (coming soon): Moves the document to the trash, out of every place. It can be restored for 30 days, then it is deleted.
- [Restore a document](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/restoreDocument.md) (coming soon): Brings a document back from the trash, to the places it was in.
- [Read a document’s text](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/getDocumentContent.md) (coming soon): Returns the text Matchai read from the file, page by page. With find, only the pages containing those words.
- [Make a document public or private](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/setDocumentVisibility.md) (coming soon): public publishes the document on the pages of the listings it is filed on, for anyone with the link.
- [Tag a document](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/setDocumentTags.md) (coming soon): Sets tags from the controlled vocabulary. Only the facets you name are replaced. The kind tag becomes the document’s name in Matchai.
- [File a document somewhere](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/fileDocument.md) (coming soon): Adds the document to a listing, a conversation, a project or a team — one file can be in several places. Give remove_from to move it rather than add it.
- [Take a document out of a place](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/unfileDocument.md) (coming soon): Takes the document out of one place.
- [List document tags](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/listDocumentTags.md) (coming soon): Returns the controlled vocabulary of document tags, facet by facet.
- [Get storage use](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/getCloudUsage.md) (coming soon): Returns how much Matchai Cloud storage the account uses.
- [List drop links](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/listDropLinks.md) (coming soon): Returns the upload links you created, newest first.
- [Create a drop link](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/createDropLink.md) (coming soon): Creates a link anyone can use to upload files into one listing or conversation, without an account — for example to collect documents from a seller or a notary.
- [Get a drop link](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/getDropLink.md) (coming soon): Returns one drop link with what it has received.
- [Revoke a drop link](https://matchai.co/docs/developers/api-reference/documents-and-drop-links/revokeDropLink.md) (coming soon): Stops the link working straight away. Files already received stay.
- [List teams](https://matchai.co/docs/developers/api-reference/teams-and-projects/listTeams.md) (coming soon): Returns the teams you are on, most recently updated first.
- [Create a team](https://matchai.co/docs/developers/api-reference/teams-and-projects/createTeam.md) (coming soon): Creates a team and its conversation, with you as owner.
- [Get a team](https://matchai.co/docs/developers/api-reference/teams-and-projects/getTeam.md) (coming soon): Returns one team.
- [Update a team](https://matchai.co/docs/developers/api-reference/teams-and-projects/updateTeam.md) (coming soon): Changes the team’s name or description. Owners and admins only.
- [Archive a team](https://matchai.co/docs/developers/api-reference/teams-and-projects/archiveTeam.md) (coming soon): Archives the team. Its listings, files and conversation are kept. Owners only.
- [Restore a team](https://matchai.co/docs/developers/api-reference/teams-and-projects/restoreTeam.md) (coming soon): Brings an archived team back. Owners only.
- [List team members](https://matchai.co/docs/developers/api-reference/teams-and-projects/listTeamMembers.md) (coming soon): Returns the team’s members and their roles.
- [Change a member’s role](https://matchai.co/docs/developers/api-reference/teams-and-projects/updateTeamMember.md) (coming soon): Makes a member an admin or a member. Ownership is transferred in Matchai, not through the API.
- [Remove a team member](https://matchai.co/docs/developers/api-reference/teams-and-projects/removeTeamMember.md) (coming soon): Takes a member off the team. They lose access to its listings, files and conversation.
- [Invite someone to a team](https://matchai.co/docs/developers/api-reference/teams-and-projects/inviteTeamMember.md) (coming soon): Invites a professional onto a team you own or administer. They join when they accept.
- [List projects](https://matchai.co/docs/developers/api-reference/teams-and-projects/listProjects.md) (coming soon): Returns the projects you are on, most recently updated first.
- [Create a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/createProject.md) (coming soon): Creates a project with its client and team conversations, with you as owner.
- [Get a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/getProject.md) (coming soon): Returns one project.
- [Update a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/updateProject.md) (coming soon): Changes the name, or replaces the description. Read the project first and keep what should stay.
- [Archive a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/archiveProject.md) (coming soon): Archives the project. Nothing in it is deleted.
- [Restore a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/restoreProject.md) (coming soon): Brings an archived project back.
- [List project members](https://matchai.co/docs/developers/api-reference/teams-and-projects/listProjectMembers.md) (coming soon): Returns the professionals and contacts on the project.
- [Put a contact on a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/addProjectMember.md) (coming soon): Puts one of your contacts on the project, for example a client or a notary.
- [Remove a project member](https://matchai.co/docs/developers/api-reference/teams-and-projects/removeProjectMember.md) (coming soon): Takes a professional or a contact off the project.
- [Invite a professional to a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/inviteProjectMember.md) (coming soon): Invites a professional to the project. They join when they accept.
- [List a project’s teams](https://matchai.co/docs/developers/api-reference/teams-and-projects/listProjectTeams.md) (coming soon): Returns the teams on the project.
- [Remove a team from a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/removeProjectTeam.md) (coming soon): Takes a team off the project.
- [Add a team to a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/addProjectTeam.md) (coming soon): Adds a team you are on to the project; its members can work on it.
- [List a project’s listings](https://matchai.co/docs/developers/api-reference/teams-and-projects/listProjectListings.md) (coming soon): Returns the listings on the project.
- [Remove a listing from a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/removeProjectListing.md) (coming soon): Takes the listing off the project. The listing is not changed.
- [Add a listing to a project](https://matchai.co/docs/developers/api-reference/teams-and-projects/addProjectListing.md) (coming soon): Adds a listing you can manage to the project.
- [List invitations](https://matchai.co/docs/developers/api-reference/teams-and-projects/listInvitations.md) (coming soon): Returns invitations to teams, projects and conversations, sent or received.
- [Get an invitation](https://matchai.co/docs/developers/api-reference/teams-and-projects/getInvitation.md) (coming soon): Returns one invitation.
- [Accept an invitation](https://matchai.co/docs/developers/api-reference/teams-and-projects/acceptInvitation.md) (coming soon): Joins the team, project or conversation you were invited to.
- [Decline an invitation](https://matchai.co/docs/developers/api-reference/teams-and-projects/declineInvitation.md) (coming soon): Declines an invitation you received.
- [Revoke an invitation](https://matchai.co/docs/developers/api-reference/teams-and-projects/revokeInvitation.md) (coming soon): Cancels an invitation you sent that is still pending. Its link stops working.
- [List notifications](https://matchai.co/docs/developers/api-reference/notifications/listNotifications.md) (coming soon): Returns the account’s notifications, newest first.
- [Count unread notifications](https://matchai.co/docs/developers/api-reference/notifications/countUnreadNotifications.md) (coming soon): Returns how many notifications are unread — the number on the bell.
- [Mark a notification as read](https://matchai.co/docs/developers/api-reference/notifications/markNotificationRead.md) (coming soon): Marks one notification as read, everywhere the account is signed in.
- [Mark all notifications as read](https://matchai.co/docs/developers/api-reference/notifications/markAllNotificationsRead.md) (coming soon): Marks every notification as read.
- [Get notification preferences](https://matchai.co/docs/developers/api-reference/notifications/getNotificationPreferences.md) (coming soon): Returns which channels and topics the account is notified about.
- [Set notification preferences](https://matchai.co/docs/developers/api-reference/notifications/setNotificationPreferences.md) (coming soon): Replaces the notification preferences.
- [List saved listings](https://matchai.co/docs/developers/api-reference/saved-listings/listSavedListings.md) (coming soon): Returns the listings the account saved while browsing, most recent first.
- [Save a listing](https://matchai.co/docs/developers/api-reference/saved-listings/saveListing.md) (coming soon): Saves a published listing. As in the app, the professional who lists it sees that you saved it, and a conversation with them opens so you can ask questions.
- [Unsave a listing](https://matchai.co/docs/developers/api-reference/saved-listings/unsaveListing.md) (coming soon): Removes a listing from the saved list. The conversation with the professional stays.
- [Get a listing’s analytics](https://matchai.co/docs/developers/api-reference/listing-analytics/getListingAnalytics.md) (coming soon): Returns the numbers on the listing’s Analytics tab: views, visitors, engaged time, clicks, where visits came from, and how AI assistants read, show and…
- [List AI activity on a listing](https://matchai.co/docs/developers/api-reference/listing-analytics/listListingAiEvents.md) (coming soon): Returns each time an AI assistant read, showed or sent someone to the listing, newest first, and whether Matchai verified it.
- [List approval requests](https://matchai.co/docs/developers/api-reference/approvals/listApprovals.md) (coming soon): Returns the final actions this connection asked the account holder to approve, newest first.
- [Get an approval request](https://matchai.co/docs/developers/api-reference/approvals/getApproval.md) (coming soon): Returns where an approval request stands. Once it is approved, result holds the response the call returned when Matchai performed it.
- [Withdraw an approval request](https://matchai.co/docs/developers/api-reference/approvals/cancelApproval.md) (coming soon): Withdraws a pending request, for example when the person changed their mind in your app. The account holder no longer sees it.
- [List webhook subscriptions](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/listWebhookSubscriptions.md) (coming soon): Returns this connection’s webhook subscriptions.
- [Subscribe to events](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/createWebhookSubscription.md) (coming soon): Starts sending events to your endpoint. The response holds the signing secret, shown this once. You only receive events about data your scopes let you read.
- [Get a webhook subscription](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/getWebhookSubscription.md) (coming soon): Returns one subscription. The secret is never returned again.
- [Update a webhook subscription](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/updateWebhookSubscription.md) (coming soon): Changes the endpoint, the events, or turns the subscription off or on.
- [Delete a webhook subscription](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/deleteWebhookSubscription.md) (coming soon): Stops sending events to this endpoint. It deletes nothing in the account.
- [Rotate the signing secret](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/rotateWebhookSecret.md) (coming soon): Issues a new signing secret. For 24 hours, deliveries carry signatures from both the old and the new secret, so you can switch without missing events.
- [Send a test event](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/testWebhookSubscription.md) (coming soon): Sends a webhook.test event to the endpoint now and returns the delivery.
- [List deliveries](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/listWebhookDeliveries.md) (coming soon): Returns recent delivery attempts to this endpoint, newest first, kept for 30 days.
- [Retry a delivery](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/retryWebhookDelivery.md) (coming soon): Sends the event of a failed delivery again, now.
- [List events](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/listEvents.md) (coming soon): Returns the events of the last 30 days for this connection, newest first — the same bodies webhooks deliver. Use it to catch up after downtime.
- [Get an event](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/getEvent.md) (coming soon): Returns one event.
- [A new lead](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onLeadCreated.md) (coming soon): Event lead.created.
- [A contact was added](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onContactCreated.md) (coming soon): Event contact.created. Any new contact, whatever its type. A new lead also sends lead.created.
- [A contact changed](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onContactUpdated.md) (coming soon): Event contact.updated. A contact’s details or lead details changed. data.previous holds the old values of the fields that changed.
- [A contact was converted](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onContactConverted.md) (coming soon): Event contact.converted. A lead became a client, or a client became a professional. data.previous.type holds the old type.
- [A contact was deleted](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onContactDeleted.md) (coming soon): Event contact.deleted. A contact was deleted.
- [A conversation started](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onConversationCreated.md) (coming soon): Event conversation.created. A new conversation the account is in.
- [A message was received](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onMessageReceived.md) (coming soon): Event message.received. Someone else wrote in a conversation the account is in.
- [A message was sent](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onMessageSent.md) (coming soon): Event message.sent. The account sent a message — from the app, the Matchai Assistant or an app like yours.
- [A visit or meeting was requested](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onAppointmentRequested.md) (coming soon): Event appointment.requested. Someone asked the account holder for a time. It waits for their answer.
- [An appointment was booked](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onAppointmentBooked.md) (coming soon): Event appointment.booked. An appointment is confirmed: booked directly, or a request was accepted.
- [An appointment moved](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onAppointmentRescheduled.md) (coming soon): Event appointment.rescheduled. An appointment has a new time, or a new time was proposed (status: reschedule_pending).
- [An appointment was cancelled](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onAppointmentCancelled.md) (coming soon): Event appointment.cancelled. An appointment was cancelled or a request was declined.
- [A listing was created](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onListingCreated.md) (coming soon): Event listing.created. A new draft listing, made by hand, by AI creation or by import.
- [A listing changed](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onListingUpdated.md) (coming soon): Event listing.updated. A listing’s fields, photos or rooms changed. data.previous holds the old values of top-level fields that changed.
- [A listing was published](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onListingPublished.md) (coming soon): Event listing.published. A listing went on the public web.
- [A listing was unpublished](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onListingUnpublished.md) (coming soon): Event listing.unpublished. A listing went back to draft.
- [A listing was archived](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onListingArchived.md) (coming soon): Event listing.archived. A listing was taken off the market.
- [A listing was deleted](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onListingDeleted.md) (coming soon): Event listing.deleted. A listing was deleted.
- [Someone saved a listing](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onListingSaved.md) (coming soon): Event listing.saved. Someone saved one of the account’s listings. data.object.contact is your contact record for them.
- [AI listing creation finished](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onListingGenerationCompleted.md) (coming soon): Event listing.generation.completed. An AI listing creation run succeeded or failed.
- [A document was added](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onDocumentCreated.md) (coming soon): Event document.created. A document was added to Matchai Cloud, by upload, by email or through a drop link.
- [A file arrived through a drop link](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onDropLinkUploadReceived.md) (coming soon): Event drop_link.upload_received. Someone uploaded a file through one of the account’s drop links.
- [An invitation was accepted](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onInvitationAccepted.md) (coming soon): Event invitation.accepted. Someone accepted an invitation the account sent.
- [A notification was created](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onNotificationCreated.md) (coming soon): Event notification.created. The account received a notification.
- [An approval request was answered](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onApprovalResolved.md) (coming soon): Event approval.resolved. A final action your app asked for was approved (and performed), declined, or expired. data.object.result holds the outcome.
- [A test event](https://matchai.co/docs/developers/api-reference/webhook-subscriptions/onWebhookTest.md) (coming soon): Event webhook.test. Sent by POST /webhook-subscriptions/{webhook_subscription_id}/test.
- [Errors](https://matchai.co/docs/developers/errors.md) (coming soon): The Matchai API error format, every error code with its HTTP status and what to do about it, which requests are safe to retry, and how to use request ids.
- [Rate limits](https://matchai.co/docs/developers/rate-limits.md): The request limits on Matchai's public MCP server and listing search today, how to read them, and how limits and RateLimit headers will work in the Matchai API.
- [Versioning](https://matchai.co/docs/developers/versioning.md) (coming soon): How the Matchai API is versioned: /v1 in the URL, which changes ship without a new version, what counts as breaking, and how deprecations are announced.
- [Changelog](https://matchai.co/docs/developers/changelog.md): What changed in the Matchai developer documentation and, once it opens, in the Matchai API: new endpoints, changes and deprecations, newest first.

## Optional

- [Matchai documentation — full text](https://matchai.co/docs/llms-full.txt)
- [Documentation Matchai](https://matchai.co/docs/fr/llms.txt)
- [Documentación de Matchai](https://matchai.co/docs/es/llms.txt)
- [Matchai](https://matchai.co/llms.txt)

## Sitemap

- [Every page of Matchai Docs](https://matchai.co/docs/sitemap.md)
- [llms.txt](https://matchai.co/docs/llms.txt)