HappierleadsDocs
Embed Happierleads screens

Cancel or unpaid

No more leads and no more refills; their data is kept for when they come back.

A client cancels, or stops paying. Two calls: no more leads, then stop the monthly refill. Tracking stops; their leads and settings are kept, so a returning client picks up where they left off.

1. Leads to 0

PUT/admin/websites/set-limits/{websiteId}
Try:
Request body
Website IdWebsite ID to update limits for
CreditsMaximum number of credits (leads/visitors) allowed. Set to 0 to disable tracking.
Email AccountsMaximum number of email accounts allowed for integrations. Set to 0 to disable email features.
Reset CreditsRefill what is left to the full allowance right now.
curl -X PUT "https://rest-admin.happierleads.com/admin/websites/set-limits/64b7f0a1c2d3e4f5a6b7c8d9?privateKey=YOUR_KEY" \  -H "Content-Type: application/json" \  -d '{  "credits": 0,  "emailAccounts": 0}'
Response
Press Send request to try it with sample data.

2. Stop the monthly refill

PUT/admin/websites/toggle-limits/{websiteId}
Try:
Request body
Website IdWebsite ID
Trial EnabledEnable or disable trial mode. - `true`: Sets website to trial mode (requires `trialExpireDate`) - `false`: Clears trial mode (sets `trialEnds` to null)
Trial Expire DateWhen the trial expires. Required when `trialEnabled` is true.
Active WebsiteEnable or disable active/paid mode. - `true`: Sets website to active mode (requires `refreshOnDate`) - `false`: Clears active mode (sets `refreshOn` to null)
Refresh On DateDate when credits will automatically reset. Required when `activeWebsite` is true. Typically set to the next billing cycle date.
Enable Website LimitsEnable or disable website-level limits. - `true`: Website uses its own limits (from `limits` field) - `false`: Website uses account-level limits (unlimited at website level)
curl -X PUT "https://rest-admin.happierleads.com/admin/websites/toggle-limits/64b7f0a1c2d3e4f5a6b7c8d9?privateKey=YOUR_KEY" \  -H "Content-Type: application/json" \  -d '{  "activeWebsite": false}'
Response
Press Send request to try it with sample data.

They come back

Run the two switch to paid calls again: everything works at once.

Leaving for good

Only when a client asks for their data to be removed: DELETE /admin/websites/{id} removes the website and all its leads. It cannot be undone, and never call it from a browser.

DELETE/admin/websites/{id}
Parameters
IdWebsite ID to delete
curl -X DELETE "https://rest-admin.happierleads.com/admin/websites/64b7f0a1c2d3e4f5a6b7c8d9?privateKey=YOUR_KEY"
Response
Press Send request to try it with sample data.

Next: go live: bring your existing clients across.

On this page