How it works
- Your contacts reach Reveal's contact index: connect HubSpot or Mailchimp (synced), Customer.io (looked up on click) or upload a CSV. Reveal keeps only a hash of each email, salted per account; unsubscribed and deleted contacts become suppressions.
- You sign one
pidper recipient and campaign withPOST /v1/reveal/links/signfrom your backend, or in bulk from the console. - You store the
pidin a contact property (for exampleprynt_pid) and add?pid=plus that merge tag to the links that point at your site. - When the recipient clicks and consent is granted on your site, the SDK reads
pid, removes it from the URL it reports and sends it with the beacon. Reveal checks the signature, the expiry and that the contact is still subscribed, then links the visit to that contact as a first-party identification (first_party_link, consent referencelink:<campaign>).
No consent, Global Privacy Control or an opt-out: the SDK never reads the token and Reveal never uses it. The token never contains the email address.
Sign tokens from your backend
curl https://api.pryntid.com/v1/reveal/links/sign \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"contactRef": "12345", "source": "hubspot", "campaign": "nov-newsletter", "ttlDays": 30}'
# 200 → {"pid": "djEuMTIu…", "expiresAt": "2026-12-03T10:00:00Z"}| Field | Meaning |
|---|---|
contactRef + source | The contact's id in its source: HubSpot record id (hubspot), Mailchimp unique email id (mailchimp), Customer.io id (customerio), your CSV contactRef (csv) |
email | Instead of contactRef: the best subscribed contact with that address |
consentRef | Only with email, for a contact Reveal does not know yet (a Klaviyo list, say): your reference of the opt-in. The contact is registered with source link |
campaign | 1–40 characters A-Z a-z 0-9 _ -, default email; recorded as the consent reference link:<campaign> |
ttlDays | Days the link works: default 30, maximum 90. A forwarded email stops working when its token expires. Share links you create in the console (a read-only account view) last 7 days by default and 30 at most |
Errors: 422 contact_not_eligible when the contact is unknown, unsubscribed, opted out or deleted; 401 without a valid secret key; 429 above 600 requests per minute per key. The endpoint needs your secret key: call it from your server, never from a browser.
Bulk sign from the console
People → Contacts → Bulk sign: upload a CSV with a contactRef (and source) or an email column, pick a campaign and a lifetime, download the file with a pid column and import it into your email tool as a contact property. Rows that cannot be signed come back with the reason.
Merge tags
| Email tool | Contact reference to sign | Decorated link |
|---|---|---|
| HubSpot | {{contact.hs_object_id}} · source hubspot | https://example.com/pricing?pid={{contact.prynt_pid}} |
| Klaviyo | your own id, or the email with consentRef | https://example.com/pricing?pid={{ person|lookup:'prynt_pid' }} |
| Mailchimp | *|UNIQID|* · source mailchimp | https://example.com/pricing?pid=*|PRYNTPID|* |
| Customer.io | {{customer.id}} · source customerio | https://example.com/pricing?pid={{customer.prynt_pid}} |
Mailchimp and Customer.io also work without signing: with click tracking on they add mc_eid / _cio_id to your links. Connect the integration and Reveal looks the subscriber up with your own API key (subscribed members only, cached for 24 hours; the key is stored encrypted).
SDK options
PryntReveal.reveal({
publicKey: 'pk_live_…',
pid: { param: 'pid', store: true }, // param defaults to 'pid'; store keeps it in localStorage 'prynt_pid'
// pid: false // turn email-link recognition off
});With store: true later visits from the same browser are recognised without the parameter; an opt-out (Global Privacy Control, setConsent(false), a refusal in your consent manager) deletes the stored token. A pid value that is not a Prynt token, such as a product id, is left untouched.
Forwarded emails
The same token used from more than 3 devices is treated as a forwarded link: the visit is still linked, with confidence 0.6 and the reason shared_link, so you can keep it out of alerts that need a strong identification. Tokens are bound to one contact of your account; a token from another account, a modified one or an expired one is ignored.
Privacy
- Only your own contacts, from tools you control, with their consent. Reveal never adds people from other customers or from third-party data.
- Reveal stores a hash of each email salted per account, never the address itself, and never puts it in a token.
- Unsubscribed, cleaned or deleted contacts become suppressions. A deletion request removes the person, marks the contact as deleted for good and, in HubSpot, anonymises Prynt's notes and sets
prynt_opted_outon the contacts Prynt created. - Tell your subscribers what you do: see Consent for the consent modes and the opt-out.
Last updated 2026-11-03 · Limits · Visitor opt-out