Sponsors · Workspace
A sponsor's own team at work, under /sponsors/{key}/manage: the page, perks and their versions, updates, locations with hours and closures, the team, counter devices, sticker kits, online code lists and settings. What each person may do follows their role: the owner does everything; admins everything except handing over ownership and leaving FundlyHub; managers keep hours, cashiers and counter devices at their locations; cashiers use the counter. A request beyond the role answers 403; anyone not on the team gets 404. Handing over ownership, leaving FundlyHub, adding an admin and pairing a counter device are confirmed with a code emailed to the person.
Overview
What needs the team, the numbers (a manager's are their locations'), the locations, recent perks used (never who) and the person's row of the access table.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Email a code to confirm a sensitive move
Before handing over ownership, leaving FundlyHub, adding an admin or pairing a counter device, a 6-digit code goes to the person's own sign-in address (FundlyHub has no 2-step sign-in). 15 minutes, 5 tries, one use. Staff never need one.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
The page
Owner and admins.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Edit the page
Owner and admins. The legal name and registration lock once the state's record matches; the category is set before review.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Perks
Every perk with its draft, the change with a reviewer, a change scheduled and the last decision; and how many are live of 10.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Add a perk (a draft)
Owner and admins.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Fine print for every perk
Owner, admins and staff. Up to five lines the sponsor sets once for all its perks; the sponsor page shows them on its Perks tab, and a perk's own fine print adds to them. Each line is plain text, up to 100 characters, with its spaces folded; a line can't name a charity, a cause or a Fundly, offer a chance to win, or mention alcohol, tobacco, vapes or cannabis (the words that send a perk's fine print to a reviewer). An empty list clears them. Logged in the audit trail.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
The lines now in force.
What sending a perk's terms would do
Owner, admins and staff. Nothing is written. The outcome submit would reach for these terms: live (now), scheduled (a change that takes something from givers waits 14 days; smaller says why, and told how many givers hear of it today: the sponsor's followers and the perk's users in 90 days, null under 10 with fewer_than: 10), in_review (a person reads it first, with the flags; staff's perks always), or draft while the sponsor isn't live. The terms are checked as on save (422 naming the field).
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
A perk's history
Anyone on the team who sees perks. What happened to the perk, oldest first: created, changed (a new version started), submitted, approved (by FundlyHub after a review), live, scheduled (a change or an ending that waits), changes_requested, not_approved, withdrawn, paused (now, until when and why) and stopped. by names a team member, or is {staff: true} for FundlyHub. audience is who a change that waits is told to: the followers and the perk's users in 90 days (under 10: fewer_than: 10).
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
"uuid"Responses
OK
The perk builder's options
The achievements perks may be for, giving achievements first (the tracks in the vocabulary's order), with their tiers and thresholds, optional canonical art (AchievementArt), what a threshold counts (unit, and the noun by plural form in units, as in "10 donations") and, in the reader's language, their title, tagline and how to earn them; the open locations (a storefront with its street, each with its city), the category and the rules (10 live, 14 days, $25).
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
How many people could use it
People whose city is the sponsor's home city holding the tier or higher. Fewer than 10 is never a number.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Query Parameters
"uuid""uuid"Responses
OK
Reorder the perks
Perks not named keep their order after these.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Start or edit a change
A draft of new terms for the perk.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The perk.
Request Body
Responses
OK
Discard the draft
A perk that was only a draft goes with it.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The perk.
Responses
OK
Send the change
A person reviews a perk worth more than $25 a use, "something else", flagged wording, and anything staff wrote. Otherwise it is approved now: at once when it is at least as good in every way, in 14 days when anything got smaller (givers are told). Publishes sponsor.perk_live or sponsor.perk_change_scheduled.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The perk.
Responses
OK
Take a change back
From a reviewer (it becomes the draft again) or a change still scheduled.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The perk.
Responses
OK
Pause a perk
Starts now and ends on its own, at most 14 days out; givers see the reason. The owner, admins and staff pause any perk; a manager pauses a perk that runs in store at their own locations and nowhere else, since a pause stops it everywhere it runs.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The perk.
Request Body
Responses
OK
Resume a perk
Back now. Whoever may pause the perk may end its pause.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The perk.
Responses
OK
End a perk
It ends in 14 days, so the givers who count on it are told first; a change in progress is dropped. Publishes sponsor.perk_change_scheduled.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The perk.
Responses
OK
Updates
The page's updates, newest first, with when the next one reaches followers' bells.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Post an update
Up to 600 characters, one photo (sponsor-photos bucket) and the locations it is about. One update a week reaches followers' bells. Updates can't name a charity, a cause or a Fundly, or promote alcohol, tobacco, vapes or cannabis. Publishes sponsor.post_published.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Delete an update
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The update.
Responses
OK
Edit an update
Shows on the page at once; bells are not sent again.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The update.
Request Body
Responses
OK
Locations
The locations the person works with (a manager's own), with their stickers and counter devices.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Add a location
A place customers visit (pinned on the map), "We come to customers" (ZIP codes served) or "Online only". US addresses; the first is the main one. A live sponsor's new location gets its free sticker kit.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Edit a location
Another address or Apple Maps place ends the address confirmation; a live sponsor's moved location gets a new kit and its old stickers stop.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The location.
Request Body
Responses
OK
Make it the main location
Its city is the sponsor's home city.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The location.
Responses
OK
Close a location for good
Off the map, history kept; its stickers and counter devices stop.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The location.
Responses
OK
Weekly hours
The week, replaced. A manager at their own locations. Overlapping hours answer location_hours_no_overlap.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The location.
Request Body
Responses
OK
Special hours or a temporary closure
A closure of a live sponsor's location tells its followers and recent givers there (sponsor.location_closure).
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The location.
Request Body
Responses
OK
Remove special hours
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The location.
The special hours.
Responses
OK
Edit special hours
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The location.
The special hours.
Request Body
Responses
OK
Team
The people, invites waiting, requests to join and an offer of ownership.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Invite someone
Owners and admins invite admins and managers; a manager invites cashiers at their own locations. An admin invite needs the emailed code (add_admin). The link lasts 30 days. Publishes sponsor.invite_sent.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Resend an invite
A fresh link (the old one stops) and 30 more days; five sends at most.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The invite.
Responses
OK
Cancel an invite
The link stops working.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The invite.
Responses
Done
Remove a team member
Never the owner.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The team member (sponsor_members.id).
Responses
OK
Change a team member
Role, locations, title, whether they show on the page. A promotion to admin needs the emailed code. The owner's role changes only by handing over ownership; anyone may change their own title.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The team member (sponsor_members.id).
Request Body
Responses
OK
Leave the team
Anyone on the team but the owner, who hands over first.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Let someone join
With the role chosen here. Publishes sponsor.member_joined.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The request to join.
Request Body
Responses
OK
Decline a request to join
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The request to join.
Responses
OK
Hand over ownership
The owner offers the sponsor to one of its admins, confirmed with the emailed code; the admin has 7 days to accept. Publishes sponsor.ownership_offered.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Cancel the offer
The owner takes it back.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Accept ownership
The admin it was offered to becomes the owner; the old owner becomes an admin. Publishes sponsor.ownership_transferred.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Decline ownership
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Counter devices
At the locations the person manages.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Add a counter device
A device for one location, with a 6-digit pairing code shown once (10 minutes) and its QR. Confirmed with the emailed code (pair_device). Publishes sponsor.sensitive_action.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
A new pairing code
For a device that has not paired; the old code stops working.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The counter device.
Request Body
Responses
OK
Remove a device
It stops working at once; past perks used keep pointing at it.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The counter device.
Responses
OK
Rename a device
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
The counter device.
Request Body
Responses
OK
Stickers and badge
Each location's kits, stickers and address confirmation, the formats, and the web badge's embed code.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Reorder stickers
Replace lost or damaged stickers (their codes stop working now) or send extra ones. Free; three kits a location in 30 days.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Settings
Contact details, the business details on record, pausing every perk and leaving FundlyHub.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
Edit the contact details
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Pause every perk
Starts now and comes back on the date picked, up to 60 days out; while paused, moves the date. With from more than a minute ahead (up to 90 days), the pause is planned instead and the hourly sponsor run starts it on the day; pausing now drops a plan. Publishes sponsor.status_changed when a pause starts.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Turn perks back on
Perks are back now; when they are not paused, calls off a planned pause.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK
My team emails
The viewer's own switches for the team emails (Weekly summary, A giver reports a perk, Online codes running low). Off stops the email; the bell still comes. Owner and admins.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Leave FundlyHub
The owner gives 14 days' notice, confirmed with the emailed code (leave) and the business's name typed out. Followers and recent givers are told today; every perk ends on the day. Publishes sponsor.status_changed.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Request Body
Responses
OK
Stay on FundlyHub
Undo leaving before the day; nothing ends.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The sponsor's slug (an old slug resolves too) or id.
Responses
OK