Skip to content

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​

GET
/sponsors/{key}/manage

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Email a code to confirm a sensitive move​

POST
/sponsors/{key}/manage/codes

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"purpose": "string"
}

Responses​

OK

application/json
JSON
{
"sent_to": "m***@fastcatcoffee.com",
"expires_at": "string",
"purpose": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


The page​

GET
/sponsors/{key}/manage/page

Owner and admins.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Edit the page​

PATCH
/sponsors/{key}/manage/page

Owner and admins. The legal name and registration lock once the state's record matches; the category is set before review.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
"string"

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Perks​

GET
/sponsors/{key}/manage/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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
{
"perks": [
],
"live": 0,
"max_live": 0,
"fine_print": [
"string"
],
"website_host": "string",
"achievements": {
"additionalProperties": {
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Add a perk (a draft)​

POST
/sponsors/{key}/manage/perks

Owner and admins.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"terms": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Fine print for every perk​

PUT
/sponsors/{key}/manage/fine-print

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"lines": [
"string"
]
}

Responses​

The lines now in force.

application/json
JSON
{
"lines": [
"string"
]
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


What sending a perk's terms would do​

POST
/sponsors/{key}/manage/perks/preview

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"terms": {
"additionalProperties": "string"
},
"perk_id": "string"
}

Responses​

OK

application/json
JSON
{
"outcome": "string",
"effective_at": "string",
"smaller": [
"string"
],
"flags": [
"string"
],
"told": {
"count": 0,
"fewer_than": 0
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


A perk's history​

GET
/sponsors/{key}/manage/perks/{perkId}/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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
perkId*
Type
string
Required
Format
"uuid"

Responses​

OK

application/json
JSON
{
"items": [
{
"at": "string",
"kind": "string",
"by": {
"name": "string",
"staff": true
},
"title": "string",
"previous_title": "string",
"effective_at": "string",
"until": "string",
"reason": "string"
}
],
"audience": {
"count": 0,
"fewer_than": 0
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


The perk builder's options​

GET
/sponsors/{key}/manage/perks/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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
{
"achievements": [
{
"id": "string",
"slug": "string",
"title": "string",
"art": "string",
"additionalProperties": "string"
}
],
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


How many people could use it​

GET
/sponsors/{key}/manage/perks/estimate

People whose city is the sponsor's home city holding the tier or higher. Fewer than 10 is never a number.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Query Parameters

achievement_id*
Type
string
Required
Format
"uuid"
tier_id*
Type
string
Required
Format
"uuid"

Responses​

OK

application/json
JSON
{
"city": {
"additionalProperties": "string"
},
"holders": 0,
"fewer_than": 0
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Reorder the perks​

PUT
/sponsors/{key}/manage/perks/order

Perks not named keep their order after these.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"perk_ids": [
"string"
]
}

Responses​

OK

application/json
JSON
{
"perk_ids": [
"string"
]
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Start or edit a change​

PUT
/sponsors/{key}/manage/perks/{perkId}/draft

A draft of new terms for the perk.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
perkId*

The perk.

Type
string
Required

Request Body​

application/json
JSON
{
"terms": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Discard the draft​

DELETE
/sponsors/{key}/manage/perks/{perkId}/draft

A perk that was only a draft goes with it.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
perkId*

The perk.

Type
string
Required

Responses​

OK

application/json
JSON
{
"deleted_perk": true
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Send the change​

POST
/sponsors/{key}/manage/perks/{perkId}/submit

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
perkId*

The perk.

Type
string
Required

Responses​

OK

application/json
JSON
{
"outcome": "string",
"effective_at": "string",
"flags": [
"string"
],
"perk": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Take a change back​

POST
/sponsors/{key}/manage/perks/{perkId}/withdraw

From a reviewer (it becomes the draft again) or a change still scheduled.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
perkId*

The perk.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Pause a perk​

POST
/sponsors/{key}/manage/perks/{perkId}/pause

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
perkId*

The perk.

Type
string
Required

Request Body​

application/json
JSON
{
"until": "string",
"reason": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Resume a perk​

DELETE
/sponsors/{key}/manage/perks/{perkId}/pause

Back now. Whoever may pause the perk may end its pause.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
perkId*

The perk.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


End a perk​

POST
/sponsors/{key}/manage/perks/{perkId}/end

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
perkId*

The perk.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Updates​

GET
/sponsors/{key}/manage/updates

The page's updates, newest first, with when the next one reaches followers' bells.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Post an update​

POST
/sponsors/{key}/manage/updates

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"body": "string",
"photo_url": "string",
"location_ids": [
"string"
]
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Delete an update​

DELETE
/sponsors/{key}/manage/updates/{postId}

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
postId*

The update.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Edit an update​

PATCH
/sponsors/{key}/manage/updates/{postId}

Shows on the page at once; bells are not sent again.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
postId*

The update.

Type
string
Required

Request Body​

application/json
JSON
{
"body": "string",
"photo_url": "string",
"location_ids": [
"string"
]
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Locations​

GET
/sponsors/{key}/manage/locations

The locations the person works with (a manager's own), with their stickers and counter devices.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
{
"locations": [
{
"id": "string",
"label": "string",
"kind": "string",
"is_primary": true,
"closed_at": "string",
"dba_id": "string",
"apple_place_id": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string"
},
"point": {
"lat": 0,
"lng": 0
},
"city": {
"id": "string",
"name": "string",
"region": "string",
"slug": "string",
"timezone": "string"
},
"hours": [
{
"weekday": 0,
"opens_at": "06:30",
"closes_at": "18:00"
}
],
"exceptions": [
{
"id": "string",
"starts_on": "string",
"ends_on": "string",
"opens_at": "string",
"closes_at": "string",
"reason": "string"
}
],
"zips": [
{
"place_id": "string",
"code": "string"
}
],
"confirmed": {
"at": "string",
"method": "string"
},
"address_changed_at": "string",
"kit_ship_to_location_id": "string",
"pickup_only": true,
"time_zone": "string",
"now": {
"additionalProperties": "string"
},
"closure": {
"additionalProperties": "string"
},
"dba_name": "string"
}
],
"max_open": 0
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Add a location​

POST
/sponsors/{key}/manage/locations

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"kind": "string",
"label": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string"
},
"point": {
"lat": 0,
"lng": 0
},
"apple_place_id": "string",
"dba_id": "string",
"pickup_only": true,
"is_primary": true,
"hours": [
{
"weekday": 0,
"opens_at": "06:30",
"closes_at": "18:00"
}
],
"zips": [
"string"
]
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Edit a location​

PATCH
/sponsors/{key}/manage/locations/{locationId}

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
locationId*

The location.

Type
string
Required

Request Body​

application/json
JSON
{
"label": "string",
"kind": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string"
},
"point": {
"lat": 0,
"lng": 0
},
"apple_place_id": "string",
"dba_id": "string",
"zips": [
"string"
],
"kit_ship_to_location_id": "string",
"pickup_only": true
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Make it the main location​

POST
/sponsors/{key}/manage/locations/{locationId}/primary

Its city is the sponsor's home city.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
locationId*

The location.

Type
string
Required

Responses​

OK

application/json
JSON
{
"locations": [
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Close a location for good​

POST
/sponsors/{key}/manage/locations/{locationId}/close

Off the map, history kept; its stickers and counter devices stop.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
locationId*

The location.

Type
string
Required

Responses​

OK

application/json
JSON
{
"locations": [
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Weekly hours​

PUT
/sponsors/{key}/manage/locations/{locationId}/hours

The week, replaced. A manager at their own locations. Overlapping hours answer location_hours_no_overlap.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
locationId*

The location.

Type
string
Required

Request Body​

application/json
JSON
{
"hours": [
{
"weekday": 0,
"opens_at": "06:30",
"closes_at": "18:00"
}
]
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Special hours or a temporary closure​

POST
/sponsors/{key}/manage/locations/{locationId}/exceptions

A closure of a live sponsor's location tells its followers and recent givers there (sponsor.location_closure).

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
locationId*

The location.

Type
string
Required

Request Body​

application/json
JSON
{
"starts_on": "string",
"ends_on": "string",
"opens_at": "string",
"closes_at": "string",
"reason": "string",
"closed": true
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Remove special hours​

DELETE
/sponsors/{key}/manage/locations/{locationId}/exceptions/{exceptionId}

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
locationId*

The location.

Type
string
Required
exceptionId*

The special hours.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Edit special hours​

PATCH
/sponsors/{key}/manage/locations/{locationId}/exceptions/{exceptionId}

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
locationId*

The location.

Type
string
Required
exceptionId*

The special hours.

Type
string
Required

Request Body​

application/json
JSON
{
"starts_on": "string",
"ends_on": "string",
"opens_at": "string",
"closes_at": "string",
"reason": "string",
"closed": true
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Team​

GET
/sponsors/{key}/manage/team

The people, invites waiting, requests to join and an offer of ownership.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Invite someone​

POST
/sponsors/{key}/manage/team/invites

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"email": "string",
"role": "string",
"title": "string",
"location_ids": [
"string"
],
"code": "string"
}

Responses​

OK

application/json
JSON
{
"invite": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Resend an invite​

POST
/sponsors/{key}/manage/team/invites/{inviteId}/resend

A fresh link (the old one stops) and 30 more days; five sends at most.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
inviteId*

The invite.

Type
string
Required

Responses​

OK

application/json
JSON
{
"invite": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Cancel an invite​

DELETE
/sponsors/{key}/manage/team/invites/{inviteId}

The link stops working.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
inviteId*

The invite.

Type
string
Required

Responses​

Done

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Remove a team member​

DELETE
/sponsors/{key}/manage/team/members/{memberId}

Never the owner.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
memberId*

The team member (sponsor_members.id).

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Change a team member​

PATCH
/sponsors/{key}/manage/team/members/{memberId}

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
memberId*

The team member (sponsor_members.id).

Type
string
Required

Request Body​

application/json
JSON
{
"role": "string",
"title": "string",
"show_on_page": true,
"location_ids": [
"string"
],
"code": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Leave the team​

POST
/sponsors/{key}/manage/team/leave

Anyone on the team but the owner, who hands over first.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
{
"left": true
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Let someone join​

POST
/sponsors/{key}/manage/team/requests/{requestId}/approve

With the role chosen here. Publishes sponsor.member_joined.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
requestId*

The request to join.

Type
string
Required

Request Body​

application/json
JSON
{
"role": "string",
"title": "string",
"location_ids": [
"string"
],
"code": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Decline a request to join​

POST
/sponsors/{key}/manage/team/requests/{requestId}/decline

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
requestId*

The request to join.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Hand over ownership​

POST
/sponsors/{key}/manage/team/transfer

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"member_id": "string",
"code": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Cancel the offer​

DELETE
/sponsors/{key}/manage/team/transfer

The owner takes it back.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Accept ownership​

POST
/sponsors/{key}/manage/team/transfer/accept

The admin it was offered to becomes the owner; the old owner becomes an admin. Publishes sponsor.ownership_transferred.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
{
"accepted": true
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Decline ownership​

POST
/sponsors/{key}/manage/team/transfer/decline

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
{
"declined": true
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Counter devices​

GET
/sponsors/{key}/manage/devices

At the locations the person manages.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
{
"devices": [
],
"code_ttl_minutes": 0
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Add a counter device​

POST
/sponsors/{key}/manage/devices

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"location_id": "string",
"name": "string",
"code": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


A new pairing code​

POST
/sponsors/{key}/manage/devices/{deviceId}/code

For a device that has not paired; the old code stops working.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
deviceId*

The counter device.

Type
string
Required

Request Body​

application/json
JSON
{
"code": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Remove a device​

DELETE
/sponsors/{key}/manage/devices/{deviceId}

It stops working at once; past perks used keep pointing at it.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
deviceId*

The counter device.

Type
string
Required

Responses​

OK

application/json
JSON
{
"removed": true
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Rename a device​

PATCH
/sponsors/{key}/manage/devices/{deviceId}

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required
deviceId*

The counter device.

Type
string
Required

Request Body​

application/json
JSON
{
"name": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Stickers and badge​

GET
/sponsors/{key}/manage/stickers

Each location's kits, stickers and address confirmation, the formats, and the web badge's embed code.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Reorder stickers​

POST
/sponsors/{key}/manage/stickers/reorder

Replace lost or damaged stickers (their codes stop working now) or send extra ones. Free; three kits a location in 30 days.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"location_id": "string",
"reason": "string",
"sticker_ids": [
"string"
],
"formats": [
"string"
],
"ship_to_location_id": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Settings​

GET
/sponsors/{key}/manage/settings

Contact details, the business details on record, pausing every perk and leaving FundlyHub.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Edit the contact details​

PATCH
/sponsors/{key}/manage/settings

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"contact_email": "string",
"phone": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Pause every perk​

POST
/sponsors/{key}/manage/settings/pause

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"until": "string",
"from": "string",
"message": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Turn perks back on​

DELETE
/sponsors/{key}/manage/settings/pause

Perks are back now; when they are not paused, calls off a planned pause.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


My team emails​

PATCH
/sponsors/{key}/manage/settings/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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"weekly_summary": true,
"reports": true,
"low_codes": true
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Leave FundlyHub​

POST
/sponsors/{key}/manage/settings/leave

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Request Body​

application/json
JSON
{
"confirm_name": "string",
"code": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Stay on FundlyHub​

DELETE
/sponsors/{key}/manage/settings/leave

Undo leaving before the day; nothing ends.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Powered by VitePress OpenAPI

Built with VitePress