Precleared

Docs ยท Quickly

Precleared in Quickly

Quickly is an open-source cold email sender. Its pre-send hook asks Precleared before the first email to a lead, then allows, holds or pauses that lead for review. Each check gives a verdict, the rule quoted with its source, what the footer must include and a signed receipt. It covers the UK, US, Canada, Germany, France, Australia, Ireland, the Netherlands, Spain, Italy, Latvia, the United Arab Emirates, Egypt and Qatar.

Connect it (about five minutes)

  1. Get a free key, or skip this step to try the shared free allowance.
  2. With your key, run this command. It returns your hook URL, secret and five settings. Keep the secret private.
    curl -s https://precleared.dev/api/v1/hooks/pre-send -H "Authorization: Bearer YOUR_KEY"
  3. Copy the five settings into Quickly's .env file, using the URL and secret returned above:
    PRE_SEND_HOOK_URL=YOUR_RETURNED_URL
PRE_SEND_HOOK_SECRET=YOUR_RETURNED_SECRET
PRE_SEND_HOOK_TIMEOUT=10
PRE_SEND_HOOK_FIELDS=contact
PRE_SEND_HOOK_ON_ERROR=hold

    FIELDS=contact lets the check see the lead's name and company. The person's name is not stored. TIMEOUT=10 matters because a UK company lookup can take several seconds. Keep ON_ERROR=hold so a connection problem cannot send an unchecked email.

  4. Optional: add sender_country, address_source and pitch to the URL. Use your business's country and the real source of the address. If known, add recipient_country too. The sender defaults to GB and the address source to unknown.
    PRE_SEND_HOOK_URL=https://precleared.dev/api/v1/hooks/pre-send/YOUR_KEY_PREFIX?sender_country=GB&address_source=published&pitch=Bookkeeping%20software
  5. Each lead gets one of three decisions:
    • allow: Quickly sends. Make sure the email meets the footer requirements in the receipt's rule.
    • deny: Quickly pauses the lead for review, with the reason and receipt id on it.
    • hold: Quickly waits and asks again. For a keyed unknown, it waits one hour, then six hours; a third unknown in seven days denies. Without a key, unknowns always wait six hours. No checks left means six hours with a key, or until the next UK day plus a minute without one. A temporary problem waits one hour.

    Quickly caches allow and deny for 30 days. A receipt records the answer at the time of the check, not permission forever.

  6. To try it without a key, use the URL below, leave PRE_SEND_HOOK_SECRET empty and keep the other four settings above.
    PRE_SEND_HOOK_URL=https://precleared.dev/api/v1/hooks/pre-send

Signed requests and replies

With a key, the secret signs the exact request and reply. Quickly sends a timestamp and signature; missing, wrong or more than five-minute-old signatures are refused before any check. A revoked key cannot run the hook.

Troubleshooting: check the five settings, leave the secret empty only for the keyless URL, and fetch settings again if signatures are refused. A rate limit holds the lead rather than allowing a send.

What each verdict means

  • ok_to_email: the address may be emailed. Follow the footer requirements in footer_text.
  • consent_needed: don't send. Follow next_step.
  • blocked: don't send. Follow next_step.
  • unknown: treat it as consent needed. Don't send until the missing facts are resolved.

Receipts

Each check returns a signed receipt. Keep its id with the lead. The hook returns its id as reference. Open https://precleared.dev/r/<receipt id> to read it. See Verifying a receipt for signature verification.

What Quickly sends

Only the recipient's address and the facts you pass: your country, where the address came from, the pitch and, if you add them, the company name, the person's name and the draft. The draft is not stored; only its hash goes on the receipt. Nothing is sent to the recipient. More on how data is handled: /security.

Allowances

Without a key, Quickly shares 10 checks a day with callers on the same network. A free key gives 14 days at 100 checks a day, starting with the first check, then 25 a day over this hook. No card needed. Checks use the same allowance and packs as the API. For more, see /buy.

Precleared's answers are decision support with sources, not legal advice.

Back to the docs