DealMachine

Adds properties to a Ready, Active or Paused campaign and spends wallet dollars. Each added property starts at step 1 on its own schedule; properties already in the campaign are untouched. Before calling this, call dealmachine_mail_read with operation add_properties_estimate and the property count, tell the user the charge due today (pay_today_cents) and the amount charged later as mail goes out (pay_later_cents), and get their approval. A paused campaign charges nothing today; each piece is charged as it goes out after it resumes (charged_on_resume). Auto-reload must be on when the campaign h…

Cancels a mail campaign, kept for existing clients. A started campaign ends as with dealmachine_mail_campaign_end; a draft is cancelled; a campaign that has already ended is returned unchanged. Unsent mail stops, while mail already submitted still delivers.

Creates or updates a draft mail campaign, or pauses or resumes a campaign. Free. Create with one audience (property_ids, contact_ids or list_ids) to make a draft. Create with no audience to save a Ready campaign that properties can be added to later with dealmachine_mail_campaign_add_properties. Set accepts_properties to true on create to keep adding properties to a campaign with an audience after it is sent. Pause works on Active campaigns, and on Ready campaigns that accept properties; an ended campaign cannot be paused or resumed.

Ends a Ready, Active or Paused mail campaign permanently. Unsent mail is stopped, no properties can be added, and it can never be resumed. Mail already printed or with the carrier still delivers. To reuse its steps, create a new campaign. A draft has not started and cannot be ended (campaign_is_draft). Warn the user that ending cannot be undone.

Launches a draft mail campaign and spends wallet dollars for its recipients and scheduled steps.

Reads mail campaigns, recipients, delivery analytics, cost estimates, designs, pricing, or wallet balance. Free. Campaign status is draft, ready, active, paused or ended. search_campaigns with accepting_properties=true lists campaigns properties can be added to now. add_properties_estimate (campaign_id, count) returns the charge due today (pay_today_cents) and later (pay_later_cents) for adding that many properties.

Execute one discovered public API operation using the connected account. Read its schema first. May mutate data, delete records, spend credits, charge a saved payment method or send mail/webhooks. Obtain user approval for those actions, estimate costs before paid work, and pass confirmed=true when required. Never automatically retry writes. No arbitrary URLs or headers.

Get the published parameters, JSON body, response schemas, credit guidance and confirmation requirement for one operation ID returned by search.

Find public API operations for tasks, addresses, activity, exports, lists, prospects, files, photos, tags, webhooks, driving, mail, billing and property/people data. Returns compact summaries; fetch one schema before executing. Empty query browses the paginated catalog.

Count matching people without consuming credits. Filters use the people catalog.

Returns one person by DealMachine person ID, with optional extended fields and associated properties. The person costs one people credit; chargeable property fields or associated properties can consume property credits.

Returns up to 250 people by DealMachine person ID, with optional extended fields and associated properties. Each found person costs one people credit; chargeable property fields or associated properties can consume property credits.

Returns people matching locations and filters, with requested fields. Filters use the people catalog; property filters return filter_source_mismatch. `estimate_cost=true` returns a credit estimate without records or credit use. Returned records can consume credits.

Read live plan prices, billing intervals, included credits, features and free API capabilities. Works before signup. Connected customers get their workspace prices. Counts and supported estimates are free; enrichment needs paid access. Read this before explaining or recommending a plan. Never invent credits, discounts or prices.

Returns the number of properties matching locations and filters without consuming credits.

Creates a downloadable CSV of properties or property-owner contacts matching locations and filters. Defaults to owner contact rows (`contact_audience=owners`, `anchor=person`) with names, phones, emails, and property addresses. `contact_audience=none` or `anchor=property` produces property rows without contacts. Exported records can consume credits.

Returns one property by DealMachine property ID. Enriched data costs one property credit unless `enrich=false`; owner contacts can consume people credits. `contact_audience=none` returns property-only data.

Returns up to 25 properties by DealMachine property ID. Owner contacts can consume people credits; `contact_audience=none` returns property-only data. Same-cycle repeats are free.

Returns properties matching locations and filters, with requested fields and optional contacts. `estimate_cost=true` returns a credit estimate without records or credit use. Returned property data and contacts can consume credits.

Tracks one record or up to 1,000 records as prospects in the workspace. Records that are prospects already are returned unchanged; archived ones come back to active. Free; no credits are charged.

Returns one prospect by prospect ID, or by the record it tracks, with its lifecycle, status (Hot, Warm, Cold, Follow up, Do Not Contact; read only), tags, and note and file counts. Free.

Adds a note (up to 10,000 characters) to a prospect. Free.

Lists the workspace prospects by lifecycle and source, optionally scoped to a list or a tag, starred only, or matching address or name words. Paged, up to 100 per page. Free.

Replaces the tags on a prospect with exactly the given tag IDs; an empty list clears them. Free.

Moves a prospect between active, opportunity, and archived, or stars it. Archiving ends its mail. With cascade enabled, it also closes open opportunities. List memberships are kept either way. Free.

Start a free DealMachine account. Returns the secure browser signup URL. Ask the user to finish signup and connect DealMachine using OAuth. Never ask for passwords, payment details or API keys in chat. Signup does not purchase a plan.

Lists the prospect tag catalog: the built-in tags every workspace has plus the workspace’s own, with how many prospects carry each. Free.

Returns live credit usage for the current billing cycle, including the total cap, spendable balance, monthly and additional pools, and usage by entity type. This read-only request is free.

Registers an https URL to receive prospect and list events. Returns the signing secret once; relay it to the user. Free.

Lists the workspace’s outbound webhooks with their event types and delivery health, plus the catalog of event types when asked. Free.

Returns whether the current credential is valid, the active organization name, and the authentication type. This read-only request is free.