> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getmailr.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Mailr is a direct-mail marketing platform for US home-services contractors. Each postcard is personalized with an AI-enhanced image of the recipient's own home and a unique QR code that leads to a personalized landing page. Campaigns can target a neighborhood the customer draws on a map, the homes around past jobs they upload or import, or fire automatically from their CRM. Mailr does not mail an uploaded recipient list. When answering questions, prefer the exact steps and UI labels from these docs, and direct users to app.getmailr.com to sign in. For anything involving account-specific data, billing disputes, or mail that appears lost, direct the user to support@getmailr.com.

# Paint Scout

> Connect Paint Scout to Mailr to trigger postcards from deals and accepted quotes, deliver landing-page leads as contacts, and track revenue.

Connecting Paint Scout lets your painting estimates do the mailing for you. A deal or an accepted quote in Paint Scout can queue a postcard campaign around that job's address, leads from your postcards land back in Paint Scout as contacts, and revenue is credited to the campaign that earned it.

## What you get

* **Triggers** — the events that can start a campaign:
  * **Deal created**
  * **Deal reaches a stage** (you pick the stage, and can optionally scope it to one pipeline)
  * **Quote accepted (sold)**
  * **Contact created**
* **Revenue tracking** — revenue books when a **quote is accepted**. In the setup wizard you'll see *"Revenue books when a quote is accepted."* The amount is the quote total after tax.
* **Lead delivery** — when someone scans your postcard and fills in the landing page form, Mailr creates a **contact** in Paint Scout with the **"Mailr" lead source**. Anything extra the visitor typed goes into the contact note.

## Connect Paint Scout

<Note>
  Paint Scout's API is in beta, and your account has to be opted in before the **API Keys** screen appears. The connect dialog says it too: *"**Beta:** Paint Scout's API is in beta — create a key under Account Settings → API Keys. If you don't see API Keys, join the OpenAPI beta from Paint Scout's help center, then come back."* If you can't get into the beta, use [Zapier](/integrations/zapier) instead.
</Note>

Only the workspace **Owner** can connect a CRM. See [Team & roles](/account/team-and-roles).

<Steps>
  <Step title="In Mailr, open Automations">
    Go to **Campaigns → Automations** in [the Mailr app](https://app.getmailr.com) and find **Paint Scout** under **CRM Connection**. Clicking a tile only opens its panel — nothing connects until you press the Connect button inside.
  </Step>

  <Step title="Create your Paint Scout API key">
    In Paint Scout, go to **Account Settings → API Keys → "+ Create New API Key"** and copy the key.
  </Step>

  <Step title="Paste the key into Mailr">
    Press **Connect Paint Scout** and paste the key. The dialog reads: *"In Paint Scout, go to Account Settings → API Keys → '+ Create New API Key', then paste the key here. We check it against your account and turn on instant sync before saving."* Mailr checks the key against your account before it saves, so a bad key never sticks.
  </Step>

  <Step title="Finish the 3-step wizard">
    The setup wizard opens on its own: **Leads → Job address → Tracking**. Confirm where lead details land, which address Mailr mails around, and how long a new customer at a mailed home still counts as a campaign result.
  </Step>
</Steps>

<Check>
  The Paint Scout tile now reads **Connected**.
</Check>

## How syncing works

Paint Scout events **fire instantly**, with an hourly sweep as a backup. There is nothing to set up on the Paint Scout side — Mailr registers the event subscription for you when you connect and removes it when you disconnect. Mailr also creates a **"Mailr" lead source** in your account if you don't already have one.

Automated campaigns use a design you've already approved and are reviewed by Mailr before anything mails.

<Note>
  The clock starts the moment you connect. Deals and quotes that closed *before* you connected never trigger a campaign. To test it, accept a fresh quote after connecting.
</Note>

## Disconnect or reconnect

Disconnecting deletes Mailr's event subscription inside Paint Scout first, then deletes the stored key. Lead sync and campaign triggers stop. Your field mappings, address settings and tracking window are kept, so reconnecting later picks up where you left off. Campaign history, leads and results are never deleted.

## Notes & limits

* **Paint Scout doesn't expose custom fields**, so there's no per-field mapping. Everything extra from a lead rides in the contact note, and trigger filters use a fixed list of properties.
* **Revenue never books at invoice or payment** — Paint Scout publishes no such event. Acceptance is the sold moment.
* Importing past work for a reactivation campaign pulls your **sold (accepted) quotes**, or your **contacts**.

## Next steps

<CardGroup cols={2}>
  <Card title="Automate campaigns" icon="workflow" href="/campaigns/automations">
    Turn a Paint Scout event into a neighborhood mailing.
  </Card>

  <Card title="How attribution works" icon="target" href="/results/attribution">
    Why a customer counts as a campaign result.
  </Card>

  <Card title="Connection troubleshooting" icon="life-buoy" href="/integrations/troubleshooting">
    Fixes for rejected keys and quiet syncs.
  </Card>

  <Card title="All integrations" icon="plug" href="/integrations/overview">
    Every CRM Mailr connects to.
  </Card>
</CardGroup>