> ## 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.

# Builder Prime

> Connect Builder Prime to Mailr to trigger postcards from clients and projects, and book revenue when a project is sold.

Connecting Builder Prime lets new clients and sold projects start postcard campaigns around the job address, and credits the money back to the campaign that earned it. Postcard leads flow the other way into Builder Prime as clients.

## What you get

* **Triggers** — the Builder Prime events that can start a campaign: **Client created**, **Client reaches a status** (you type the status name), **Project sold** (contract or sold status), and **Project completed**. You choose the event on each [automation](/campaigns/automations).
* **Revenue tracking** — revenue books when a project is **sold**: either a signed contract amount exists, or the project moves into a post-sale status. Mailr books the contracted amount and falls back to the estimate. Job completion never books revenue.
* **Lead delivery** — when someone scans your postcard and fills in the landing page, Mailr creates a client in Builder Prime with the "Mailr" lead source. Builder Prime creates that lead source automatically if you don't already have one. Extra answers from the form go into the client notes and an activity note.

## Connect Builder Prime

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

  <Step title="Generate an API key in Builder Prime">
    In Builder Prime, go to **Admin → Integrations → Open API → "Generate New API Key"**. Tick the **client** and **project read** scopes. The key is shown once, so copy it before you close the screen.
  </Step>

  <Step title="Paste both values in Mailr">
    Press **Connect Builder Prime**. There are two fields. **Builder Prime address** is your subdomain — *"Paste the full URL or just the part before `.builderprime.com`"*, for example `yourcompany.builderprime.com`. **API key** is the key you just generated. Mailr validates both against your account before saving.
  </Step>
</Steps>

<Check>The tile switches to **Connected** and the 3-step setup wizard opens: **Leads → Job address → Tracking**.</Check>

## How syncing works

Builder Prime is **checked hourly**. As Mailr puts it in the app: *"Checked hourly (near-real-time is the fastest Builder Prime supports)."* Builder Prime has no way to push events the moment they happen, so a campaign can be queued up to an hour after the client or project changes. Clients and projects both sync on that hourly rhythm.

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

<Note>
  The first sync starts the clock the moment you connect. Clients and projects that were already sold or completed before you connected will never trigger a campaign. To test the connection, move a fresh record forward after connecting, then wait for the next hourly check.
</Note>

## Disconnect or reconnect

Disconnecting shows a confirmation titled **"Disconnect Builder Prime?"**: *"Lead sync and campaign triggers through this connection will stop, and the stored credentials are deleted. Your settings are kept, so reconnecting later picks up where you left off."*

Mailr deletes your stored key. There's nothing to remove on the Builder Prime side. Your campaign history, leads and results stay put, and reconnecting keeps your field mappings, job-address choice and attribution window.

## Notes & limits

* **Status names are typed, not picked from a list.** Builder Prime doesn't publish a catalog of statuses, so Mailr suggests values it has seen in your recent records and lets you type your own. Type the status exactly as it reads in Builder Prime — capitalization doesn't matter.
* **Check the subdomain if the connection is refused.** A typo in the Builder Prime address gets its own error at connect, separate from a rejected key. The subdomain is the part before `.builderprime.com` in your browser's address bar when you're logged in.
* **A missing scope looks like a bad key.** If the key is rejected, regenerate it with the client and project read scopes ticked.
* Builder Prime matches incoming leads on phone first, so email matching is best-effort.

Still stuck? See [Troubleshooting connections](/integrations/troubleshooting) or [contact support](/resources/contact-support).