DealMachine API Documentation

This is the complete API documentation for connecting to the DealMachine API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet DealMachine: Manage real estate leads, lists, tags, notes, and mail sequences. Keep reading to get started.

Quickstart

Before you run your first DealMachine request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one DealMachine connection — create or choose one in Connections. Note its connectionId.

Every DealMachine action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/dealMachine/actions/{actionSlug}/run

You need a MindCloud API Key and a DealMachine connection. Then call an action such as List Lead Statuses:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/dealMachine/actions/list-lead-statuses/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your DealMachine account. See DealMachine API Authentication for the full flow and how to get your connection credentials.

DealMachine actions

All 21 published actions for this DealMachine version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Lead
• PUTAdd Lead To Lists
• PUTAdd Tags To Lead
• PUTAssign Team Member To Lead
• POSTCreate Lead Note
• DELETEDelete Lead
• PUTEnd Lead Mail Sequence
• GETGet Lead
• GETList Custom Fields
• GETList Lead Statuses
• GETList Leads
• GETList Lists
• GETList Mail Sequences
• GETList Tags
• GETList Team Members
• PUTPause Lead Mail Sequence
• PUTRemove Lead From Lists
• PUTRemove Tags From Lead
• PUTStart Lead Mail Sequence
• PUTUpdate Lead Custom Field
• PUTUpdate Lead Status

Related apps

More Sales & CRM apps on the Universal API, behind the same REST shape. Or browse all apps.

PipedriveGoogle TasksGoogle ContactsTodoistZoho CRMFollow Up BossCloseDubsado