# Mailr Help Center

> Mailr sends smart direct-mail postcards for home-services businesses: every card features an AI-enhanced image of the recipient's own home and a trackable QR code, and campaigns can run automatically from your CRM.

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

## Docs

- [Welcome to Mailr](https://docs.getmailr.com/index.md): Mailr sends personalized direct-mail postcards for home-services businesses, each featuring the recipient's own home and a trackable QR code.
- [Set up your workspace](https://docs.getmailr.com/getting-started/set-up-your-workspace.md): Create your Mailr account and company workspace, then let Mailr read your website to build your brand kit, landing pages, and reviews automatically.
- [Send your first campaign](https://docs.getmailr.com/getting-started/quickstart.md): A seven-step path from creating your Mailr workspace to watching scans and leads arrive from your first mailed postcards.
- [How Mailr works](https://docs.getmailr.com/getting-started/how-mailr-works.md): Mailr mails postcards personalized with the recipient's own home and a unique QR code, then tracks every scan and lead back to the card that produced it.
- [First-run tour and checklist](https://docs.getmailr.com/getting-started/onboarding-checklist.md): The seven-step welcome tour and the six-step getting-started checklist on your Mailr dashboard, including how to minimize, resume, replay, or hide them.
- [Team & roles](https://docs.getmailr.com/account/team-and-roles.md): Invite teammates to your Mailr workspace, choose between the Owner, Staff, and Member roles, and switch between workspaces.
- [Workspace settings](https://docs.getmailr.com/account/workspace-settings.md): Set your industry, mail and customer cooldowns, notification email, Slack alerts, and landing-page tracking pixels on the Account Settings page.
- [Campaigns overview](https://docs.getmailr.com/campaigns/overview.md): A campaign is one batch of personalized postcards. Learn Mailr's campaign types, where campaigns live, and how credits are held, charged, and refunded.
- [Create a campaign](https://docs.getmailr.com/campaigns/create-a-campaign.md): Step-by-step walkthrough of Mailr's four-step campaign wizard: Type, Targeting, Settings, and Review, plus what happens when you submit.
- [Choose your audience](https://docs.getmailr.com/campaigns/targeting.md): How Mailr picks who gets a postcard: map draws, radius circles, property filters, past job addresses, and the exclusions that trim your list.
- [Automate campaigns from your CRM](https://docs.getmailr.com/campaigns/automations.md): Set up automations so a won deal or completed job in your CRM automatically mails the neighbors around that address, with built-in over-mailing guardrails.
- [Landing pages](https://docs.getmailr.com/results/landing-pages.md): Build the page homeowners see when they scan your postcard's QR code, publish it, and understand how Mailr personalizes and freezes it per campaign.
- [Campaign statuses & timelines](https://docs.getmailr.com/campaigns/statuses-and-timelines.md): What every Mailr campaign status means — Draft through Mailed — plus preview run stages and when you can still cancel.
- [Suppression list & opt-outs](https://docs.getmailr.com/campaigns/opt-outs-and-suppression.md): Keep addresses off your mail with the suppression list, learn Do Not Contact vs Customer entries, and see how recipients opt out from a postcard.
- [Campaign troubleshooting](https://docs.getmailr.com/campaigns/troubleshooting.md): Fixes for common Mailr campaign problems: stuck in Submitted, automations held for credits, rejections, small audiences, and fewer cards than expected.
- [Designs overview](https://docs.getmailr.com/designs/overview.md): How Mailr designs work: templates versus your own designs, the brand kit, Home Render and Classic postcards, and approving a design before it can mail.
- [What's personalized on each card](https://docs.getmailr.com/designs/personalization.md): Three things change per recipient on a Mailr postcard: the AI-rendered image of their home, their unique QR code, and the mailing address. No merge fields.
- [Brand kit](https://docs.getmailr.com/designs/brand-kit.md): Build your Mailr brand kit from your website or a brand guidelines PDF, then fine-tune colors, logos, company details, and showcase photos.
- [Design templates](https://docs.getmailr.com/designs/templates.md): Browse Mailr's postcard template gallery, filter by industry and card type, and pick the starting point for your own design.
- [Create a design](https://docs.getmailr.com/designs/create-a-design.md): Walk the four-step Mailr design flow — brand kit, template, direction, review and approve — to turn a template into a postcard that's ready to mail.
- [Edit a design with AI](https://docs.getmailr.com/designs/edit-with-ai.md): Refine a Mailr postcard by describing the change: one side at a time, up to two reference images, every edit saved as a new version you can return to.
- [Upload your own design](https://docs.getmailr.com/designs/upload-your-own.md): Bring print-ready 6 × 9 in postcard artwork to Mailr: exact file specs, the artwork check, QR placement, the postal area, and how to fix a rejected file.
- [How property imagery works](https://docs.getmailr.com/designs/property-imagery.md): Mailr builds each Home Render card from imagery of the recipient's actual home. Previews show a sample house; homes without imagery are dropped, refunded.
- [QR codes on your postcards](https://docs.getmailr.com/designs/qr-codes.md): Every Mailr postcard carries a unique QR code that opens that recipient's personalized landing page and records the scan. Here's where it goes and how it's placed.
- [Integrations overview](https://docs.getmailr.com/integrations/overview.md): How connecting your CRM to Mailr triggers postcards from your jobs and deals, delivers leads back, and credits revenue to the campaign that earned it.
- [AccuLynx](https://docs.getmailr.com/integrations/acculynx.md): Connect AccuLynx to Mailr to trigger postcards from jobs, milestones and invoices, and book revenue when a job is approved.
- [Builder Prime](https://docs.getmailr.com/integrations/builder-prime.md): Connect Builder Prime to Mailr to trigger postcards from clients and projects, and book revenue when a project is sold.
- [HighLevel](https://docs.getmailr.com/integrations/gohighlevel.md): Connect HighLevel to Mailr to trigger postcards from opportunities, contacts and tags, deliver leads back, and book revenue on won opportunities.
- [Housecall Pro](https://docs.getmailr.com/integrations/housecall-pro.md): Connect Housecall Pro to Mailr to trigger postcards from jobs, estimates and invoices, and book revenue when an estimate is approved.
- [HubSpot](https://docs.getmailr.com/integrations/hubspot.md): Connect HubSpot to Mailr to trigger postcards from deals and contacts, deliver landing-page leads back as contacts, and book revenue on closed-won deals.
- [Jobber](https://docs.getmailr.com/integrations/jobber.md): Connect Jobber to Mailr to trigger postcards from jobs and quotes, deliver landing-page leads back as lead clients, and book revenue on approved quotes.
- [JobNimbus](https://docs.getmailr.com/integrations/jobnimbus.md): Connect JobNimbus to Mailr to trigger postcards when jobs reach a status you pick, and book revenue when an estimate is approved.
- [JobTread](https://docs.getmailr.com/integrations/jobtread.md): Connect JobTread to Mailr to trigger postcards from jobs and customer orders, and book revenue when a customer order is approved.
- [Leap](https://docs.getmailr.com/integrations/leap.md): Connect Leap to Mailr to trigger postcards from jobs and proposals, and book revenue when a proposal is accepted.
- [Paint Scout](https://docs.getmailr.com/integrations/paintscout.md): Connect Paint Scout to Mailr to trigger postcards from deals and accepted quotes, deliver landing-page leads as contacts, and track revenue.
- [ProLine](https://docs.getmailr.com/integrations/proline.md): Connect ProLine to Mailr to fire postcards instantly from project, quote and invoice events, deliver Web Leads, and track approved-quote revenue.
- [RoofLink](https://docs.getmailr.com/integrations/rooflink.md): Connect RoofLink to Mailr to trigger postcards when jobs reach a lead status, deliver leads back as RoofLink jobs, and book revenue on approved jobs.
- [Service Fusion](https://docs.getmailr.com/integrations/service-fusion.md): Connect Service Fusion to Mailr to trigger postcards from jobs and estimates, deliver leads, and book revenue when an estimate hits your sold status.
- [Integration troubleshooting](https://docs.getmailr.com/integrations/troubleshooting.md): Fixes for CRM connections that don't trigger campaigns, ask you to reconnect, miss revenue, or don't deliver leads back into your CRM.
- [CallRail](https://docs.getmailr.com/integrations/callrail.md): Connect CallRail to Mailr so phone calls to your tracking numbers count as direct-mail results alongside QR scans and form leads.
- [Zapier](https://docs.getmailr.com/integrations/zapier.md): Use the Mailr app for Zapier to trigger postcard campaigns, record revenue, and sync leads with any CRM Zapier supports, like ServiceTitan or Salesforce.
- [Custom integration](https://docs.getmailr.com/integrations/custom.md): Connect your own software to Mailr with the Developer API to trigger campaigns from your events, receive postcard leads back, and report won deals.
- [Website embed widget](https://docs.getmailr.com/integrations/embed-widget.md): Add Mailr's embed snippet to your own landing page so postcard scanners see a rendering of their own home, and everyone else sees a stock sample.
- [Tracking dashboard](https://docs.getmailr.com/results/dashboard.md): Read your Mailr Tracking dashboard: cards sent, QR scans, scan rate, leads, deals, revenue and ROAS, plus the scan map and per-campaign breakdowns.
- [Leads](https://docs.getmailr.com/results/leads.md): See every lead your mail produced in Mailr: where it came from, whether it reached your CRM, and what to do when a hand-off fails.
- [How attribution works](https://docs.getmailr.com/results/attribution.md): How Mailr connects a mailed postcard to a scan, a lead, a phone call and a won job — and what Direct, Indirect and Combined attribution each count.
- [Credits & pricing](https://docs.getmailr.com/billing/credits-and-pricing.md): How Mailr credits work: buy credits up front, they are held when you submit a campaign, charged per card produced, and expire 12 months after purchase.
- [Payments & invoices](https://docs.getmailr.com/billing/payments-and-invoices.md): Pay for Mailr credits by card, understand every checkout result screen, update your payment method, find receipts, and fix a failed payment.
- [Refunds & credit returns](https://docs.getmailr.com/billing/refunds.md): Mailr refunds credits automatically for cards it never produces — withdrawn campaigns, unusable home imagery, undeliverable addresses, failed AI edits.
- [Frequently asked questions](https://docs.getmailr.com/resources/faq.md): Quick answers to the questions Mailr customers ask most — costs, delivery times, designs, CRM connections, tracking, and what homeowners see.
- [Glossary](https://docs.getmailr.com/resources/glossary.md): Plain-English definitions of every Mailr term — from brand kit and Home Render to credits, cooldowns, attribution, and ROAS.
- [Data & privacy](https://docs.getmailr.com/resources/data-and-privacy.md): What data powers Mailr campaigns, where your workspace data lives, what homeowners see on a postcard and landing page, and how to opt out of future mail.
- [Contact support](https://docs.getmailr.com/resources/contact-support.md): How to reach the Mailr team, what to include in your message, and where to check first for quick answers.
- [Mailr Developer API](https://docs.getmailr.com/api-reference/overview.md): Drive Mailr's per-recipient postcard engine directly from your own CRM or automation stack with a per-tenant bearer key.
- [Send events](https://docs.getmailr.com/api-reference/send-events.md): Push CRM/automation events to POST /api/v1/events; Mailr matches them against your automations and mails per-recipient postcards.
- [Receive leads](https://docs.getmailr.com/api-reference/receive-leads.md): Subscribe an endpoint to receive Mailr landing-page leads, verify the HMAC signature, and avoid echo loops.
- [Attribution & revenue](https://docs.getmailr.com/api-reference/attribution.md): Report won deals and synced leads so revenue and conversions attribute to the campaign that mailed the address.
- [Import past jobs](https://docs.getmailr.com/api-reference/import-jobs.md): Stage a batch of completed jobs or customers for a reactivation campaign via POST /api/v1/import/jobs.
- [Errors & rate limits](https://docs.getmailr.com/api-reference/errors.md): Error body shape, the two error-code conventions in the Mailr API, per-endpoint rate limits, and retry guidance.
- [Go-live checklist](https://docs.getmailr.com/api-reference/go-live.md): Eight things to confirm before pointing production traffic at the Mailr Developer API.
- [MCP server](https://docs.getmailr.com/api-reference/mcp.md): Drive Mailr conversationally from Claude Code, Claude Desktop, or any MCP client — a thin proxy over the same /api/v1/* endpoints.
- [Ingest a CRM/automation event](https://docs.getmailr.com/api-reference/events/ingest-a-crmautomation-event.md): Push one event from your CRM/automation stack. Mailr matches it against the automations bound to your `custom` connection and, when a binding fires, enqueues a per-recipient postcard campaign through the same core the native CRM syncs use.
- [Stage past jobs or customers for a reactivation campaign](https://docs.getmailr.com/api-reference/imports/stage-past-jobs-or-customers-for-a-reactivation-campaign.md): Push a batch of up to 500 completed jobs (or customers). Mailr geocodes every address and **stages** the batch — nothing is mailed and no campaign is created. The campaign wizard reads the staged batch later, in the exact shape a CSV upload produces.
- [Subscribe an endpoint to receive captured leads](https://docs.getmailr.com/api-reference/leads/subscribe-an-endpoint-to-receive-captured-leads.md): Register a public HTTPS URL to receive `lead.created` deliveries (a lead captured on one of your Mailr landing pages). Only landing-page leads fan out here — CRM-synced leads (see `POST /api/v1/tracking/lead`) never do, to avoid an echo loop.
- [Remove a lead subscription](https://docs.getmailr.com/api-reference/leads/remove-a-lead-subscription.md): Delete a subscription by `id` or by `target_url` (org-scoped; you can only delete your own).
- [Poll recent landing-page leads](https://docs.getmailr.com/api-reference/leads/poll-recent-landing-page-leads.md): Return this org's most recent landing-page leads, newest first, capped at 50. Optional `?since=<ISO>` returns leads created strictly after that timestamp. Only `source=landing_page` leads are returned — CRM-synced leads are never polled back out. De-dupe by `id`.
- [Rotate a subscription's signing secret](https://docs.getmailr.com/api-reference/webhooks/rotate-a-subscriptions-signing-secret.md): Mints a new signing secret for one of your webhook subscriptions and returns it exactly once (companion to the disclose-once policy on subscribe). Identify the subscription by `id` or by `target_url` (+ optional `event`, default `lead.created`); always scoped to the API key's organization. Rotation…
- [Sync a new lead for indirect attribution](https://docs.getmailr.com/api-reference/attribution/sync-a-new-lead-for-indirect-attribution.md): Report a new lead/contact from your CRM. Mailr geo-matches the address to a campaign it mailed and records an **indirect** lead (source `crm_sync`). Unmatched leads are discarded — they aren't ours to track. These leads are never delivered back out. Idempotency uses `crm_record_id` when supplied, th…
- [Report a won deal for revenue attribution](https://docs.getmailr.com/api-reference/attribution/report-a-won-deal-for-revenue-attribution.md): Report a won deal. Mailr resolves the deal's address back to the campaign that mailed it (geo-first, last-touch, 180-day window, org-scoped) and upserts an idempotent conversion. Unmatched deals are discarded. The address is also recorded as an existing customer regardless of whether revenue attribu…
- [Trigger a specific automation directly](https://docs.getmailr.com/api-reference/attribution/trigger-a-specific-automation-directly.md): Fire one named automation directly (the pre-v1 path the Zapier app and HubSpot workflows use). Prefer `POST /api/v1/events` for new integrations — it binds by event type instead of hardcoding an automation id and reports richer outcomes. The target automation is named in `?id=` and must belong to th…
- [Register existing customers for suppression](https://docs.getmailr.com/api-reference/customers/register-existing-customers-for-suppression.md): Register one or more existing-customer addresses so they are suppressed from future mailings. Accepts a single `{ address, notes? }` or a batch `{ addresses: [...] }`. Upserted on the normalized address per org.
- [Identify the key's organization](https://docs.getmailr.com/api-reference/account/identify-the-keys-organization.md): Return the organization that owns the presented key. Used as an auth test and connection label. `org_id` is an org id (`org_…`) for org-scoped keys or a user id (`user_…`) for a solo tenant.
- [List the org's automations](https://docs.getmailr.com/api-reference/account/list-the-orgs-automations.md): Return the org's automations as `{ id, name, enabled }`, sorted by name. Use this to discover automation ids for `POST /api/v1/webhooks/trigger`.
- [Lead captured outbound delivery](https://docs.getmailr.com/api-reference/lead-captured-outbound-delivery.md): When a lead is captured on one of your Mailr landing pages, Mailr POSTs this payload to every subscription registered for `lead.created`. Only landing-page leads are delivered; CRM-synced leads never are.

## OpenAPI Specs

- [openapi](https://docs.getmailr.com/api-reference/openapi.yaml)