# DealMachine API Documentation

This is the complete API documentation for connecting to the DealMachine API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **DealMachine connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

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

## DealMachine actions

- POST `add-lead` Add Lead
- PUT `add-lead-to-lists` Add Lead To Lists
- PUT `add-tags-to-lead` Add Tags To Lead
- PUT `assign-team-member-to-lead` Assign Team Member To Lead
- POST `create-lead-note` Create Lead Note
- DELETE `delete-lead` Delete Lead
- PUT `end-lead-mail-sequence` End Lead Mail Sequence
- GET `get-lead` Get Lead
- GET `list-custom-fields` List Custom Fields
- GET `list-lead-statuses` List Lead Statuses
- GET `list-leads` List Leads
- GET `list-lists` List Lists
- GET `list-mail-sequences` List Mail Sequences
- GET `list-tags` List Tags
- GET `list-team-members` List Team Members
- PUT `pause-lead-mail-sequence` Pause Lead Mail Sequence
- PUT `remove-lead-from-lists` Remove Lead From Lists
- PUT `remove-tags-from-lead` Remove Tags From Lead
- PUT `start-lead-mail-sequence` Start Lead Mail Sequence
- PUT `update-lead-custom-field` Update Lead Custom Field
- PUT `update-lead-status` Update Lead Status