Skip to content

Sponsors · Become a sponsor​

Making a business a sponsor: finding it, a draft saved as you go through five steps, showing you run it (a code sent to a work email at the website's domain, or a document a person reviews), submitting it for review, asking to join an existing sponsor's team, telling FundlyHub a sponsor is your business, and accepting a team or owner invite. Needs a signed-in session.


For businesses​

GET
/sponsors/join

What /sponsors/join shows beyond its own words, all of it real: the ambassador whose link brought the visitor (ref); the visitor's city (where the edge says they are, else their own city; the nearest with sponsors within 30 miles, else the one with the most) with its sponsor count and its most used sponsors' logos; and a sponsor's quote, shown only with consent once staff approved it. No city or no quote: null.

Parameters​

Query Parameters

ref

An ambassador's code, from /sponsors/join?ref=.

Type
string

Responses​

OK

application/json
JSON
{
"inviter": {
"name": "string",
"initials": "string"
},
"city": {
"slug": "string",
"name": "string",
"label": "string",
"sponsors": 0,
"more": 0,
"logos": [
{
"slug": "string",
"name": "string",
"logo_url": "string"
}
]
},
"quote": {
"text": "string",
"name": "string",
"initials": "string",
"role": "string",
"title": "string",
"sponsor": {
"slug": "string",
"name": "string"
}
}
}

Playground​

Server
Variables
Key
Value

Samples​


The small map of a place​

GET
/sponsors/map/place

Redirects (302) to a signed Apple Maps snapshot of the street around a pin. 404 when no signing key is configured, and the page shows its pin tile instead.

Parameters​

Query Parameters

lat*
Type
number
Required
lng*
Type
number
Required
s

The tile's side in CSS pixels.

Type
integer
Minimum
32
Maximum
192
scheme
Type
string
Valid values
"light""dark"

Responses​

The snapshot.

Playground​

Server
Variables
Key
Value

Samples​


Tell me when sponsors open in my country​

POST
/sponsors/new/waitlist

For a business outside the US. The person and the country; the message goes to their own email when sponsors open there, and nothing else.

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)

Request Body​

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

Responses​

OK

application/json
JSON
{
"country_code": "string",
"waiting": true
}

Playground​

Server
Authorization
Body

Samples​


What the Become a sponsor forms need​

GET
/sponsors/new

The categories with whether each may join, the Sponsor Terms version and the most unfinished drafts one person may have.

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)

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization

Samples​


My unfinished sponsors​

GET
/sponsors/drafts

Drafts and sponsors sent back for changes that the person started, newest 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)

Responses​

OK

application/json
JSON
{
"drafts": [
{
"additionalProperties": "string"
}
]
}

Playground​

Server
Authorization

Samples​


Is this business already on FundlyHub?​

GET
/sponsors/find

Sponsors that may already be the business: the same Apple Maps place, the same website, or a close name; with whether the person is on its team, asked to join or claimed it. Apple Maps itself is searched in the browser. Drafts and sponsors under review are never shown to others.

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​

Query Parameters

q
Type
string
apple_place_id
Type
string
website
Type
string

Responses​

OK

application/json
JSON
{
"matches": [
{
"additionalProperties": "string"
}
],
"drafts": [
{
"additionalProperties": "string"
}
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Ask to join a sponsor's team​

POST
/sponsors/{key}/join-requests

The owner or an admin decides. Needs a verified email.

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
{
"message": "string"
}

Responses​

OK

application/json
JSON
{
"id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


It's my business — tell us​

POST
/sponsors/{key}/claims

An ownership question a person at FundlyHub looks into, with proof the person runs the business (a document kept privately with the claim, never one of the sponsor's own). Needs a verified email.

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
{
"note": "string",
"doc_type": "string",
"file_name": "string",
"file_base64": "string"
}

Responses​

OK

application/json
JSON
{
"id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


The draft, as the five steps read it​

GET
/sponsors/{key}/onboarding

Its page, locations, proof, owners, first perk and terms, and what still blocks submitting.

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​


Delete a draft​

DELETE
/sponsors/{key}/onboarding

Only a draft that never went to review; only the person who started it (or staff for one staff added).

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​

Done

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Save a step​

PATCH
/sponsors/{key}/onboarding

The step the person is on; step 2's title, 25%-owners answer and statement; and any page fields (as PATCH /sponsors/{key}/manage/page). One request saves a step whole. A draft follows its name to a new address; a new legal name clears the statement.

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
{
"name": "string",
"legal_name": "string",
"entity_type": "string",
"registration_state": "string",
"registration_number": "string",
"ein": "string",
"category_id": "string",
"about": "string",
"logo_url": "string",
"contact_email": "string",
"phone": "string",
"services": [
"string"
],
"website": "string",
"links": [
{
"url": "string",
"label": "string"
}
],
"names": [
{
"id": "string",
"name": "string"
}
],
"step": 0,
"title": "string",
"owners": [
],
"authority_statement": true
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Run the automatic checks before submitting​

POST
/sponsors/{key}/onboarding/checks

The state registry (California's at launch) and the sanctions lists, run while the review step is open so it can show them. They only add evidence; submitting runs them 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

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Show you run it: send a code to your work email​

POST
/sponsors/{key}/verify/email-code

The address must be at the domain of the business's own website (website saves it first). Free email domains, and a website on another company's platform, can't prove it. 15 minutes, 5 tries.

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",
"website": "string"
}

Responses​

OK

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

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Show you run it: enter the code​

POST
/sponsors/{key}/verify/email

A right code records the proof (a sponsor_checks pass).

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",
"code": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Show you run it: upload a document​

POST
/sponsors/{key}/verify/documents

A business license, a state filing naming you, the IRS EIN letter... Kept private; a person reads it (about 2 business days). PDF, JPG, PNG or HEIC up to 7 MB, as base64; the type is read from the file.

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
{
"doc_type": "string",
"file_name": "string",
"file_base64": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Take back a document​

DELETE
/sponsors/{key}/verify/documents/{docId}

Only one nobody has read yet.

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
docId*

The document.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Who owns 25% or more​

PUT
/sponsors/{key}/owners

Everyone who owns 25% or more, screened against the U.S. Treasury's sanctions list; an empty list says no one does. Four 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

Request Body​

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

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Submit for review​

POST
/sponsors/{key}/submit

The owner accepts the Sponsor Terms; the authority statement is the one confirmed on step 2, or authority_statement confirms it now. The application and the first perk go to a FundlyHub reviewer. Publishes sponsor.application_submitted.

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_version": "string",
"authority_statement": true
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Take the application back​

POST
/sponsors/{key}/withdraw

While it waits for review; it becomes a draft 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

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


A team or owner invite​

GET
/sponsor-invites/{token}

What the invite page shows, for the caller: the sponsor, the role and locations, and whether accepting will work.

Authorizations​

or
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

token*

The invite token from the email link.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​


Accept an invite​

POST
/sponsor-invites/{token}/accept

One of the person's verified emails must be the invited one. An owner invite also takes the 25%-owners answer, the Sponsor Terms and the authority statement, and sends the sponsor to review. 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

token*

The invite token from the email link.

Type
string
Required

Request Body​

application/json
JSON
{
"owners": [
{
"full_name": "string",
"me": true
}
],
"terms_version": "string",
"authority_statement": true
}

Responses​

OK

application/json
JSON
{
"slug": "string",
"sponsor_id": "string",
"role": "string",
"joined": true
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Decline an invite​

POST
/sponsor-invites/{token}/decline

Declining an owner invite hands the sponsor back to staff as a draft.

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

token*

The invite token from the email link.

Type
string
Required

Responses​

OK

application/json
JSON
{
"declined": true
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


My business invites​

GET
/me/sponsor-invites

The team and owner invites waiting for the signed-in person, so they can join or decline in the app and not only from the email's link. An invite sent to their sign-in email while it is unconfirmed is listed under unconfirmed by address alone.

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)

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization

Samples​


Accept one of my business invites​

POST
/me/sponsor-invites/{inviteId}/accept

The invite page's accept, by the invite's id. A team invite takes nothing; an owner invite takes the 25%-owners answer, the Sponsor Terms and the authority statement, and sends the sponsor to review. 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

inviteId*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"owners": [
{
"full_name": "string",
"me": true
}
],
"terms_version": "string",
"authority_statement": true
}

Responses​

OK

application/json
JSON
{
"slug": "string",
"sponsor_id": "string",
"role": "string",
"joined": true
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Decline one of my business invites​

POST
/me/sponsor-invites/{inviteId}/decline

The invite page's decline, by the invite's id. Declining an owner invite hands the sponsor back to staff as a draft.

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

inviteId*
Type
string
Required
Format
"uuid"

Responses​

OK

application/json
JSON
{
"declined": true
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Does the owner still have to finish joining​

GET
/sponsors/{key}/finish-joining

When a super admin accepted the owner invite for this person, the sponsor waits for the owner's own answers. Pending while the sponsor is waiting for its owner, the caller is its owner, and nobody accepted its terms.

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 page link or id.

Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Finish joining as the owner​

POST
/sponsors/{key}/finish-joining

The rest of the owner invite, from the owner a super admin seated. Records who owns 25% or more, the Sponsor Terms and the authority statement, and sends the sponsor to review with a second reviewer. Publishes sponsor.application_submitted.

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 page link or id.

Type
string
Required

Request Body​

application/json
JSON
{
"owners": [
{
"full_name": "string",
"me": true
}
],
"terms_version": "string",
"authority_statement": true
}

Responses​

OK

application/json
JSON
{
"slug": "string",
"sponsor_id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Start a sponsor (a draft)​

POST
/sponsors

A draft saved as you go; the person who starts it is its owner. At most three unfinished drafts per person. ref is an ambassador code from /sponsors/join?ref=. Needs a verified email. is_sponsor: false starts a business that only lists help in Resources (/resources/join, "Add your business"; #2422): the same steps and checks (who runs it, the registry, sanctions, the 25%-owners answer, the terms) with no first perk and no sticker kits, and its home a storefront or a service-area or online location (never a private storefront). While sponsors are off and Resources are on, such a business can still be started here, finish its steps and use its workspace (#2426); a sponsor's draft, and a sponsor's perks and stickers, answer 403 until sponsors are on.

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)

Request Body​

application/json
JSON
{
"name": "string",
"category_id": "string",
"ref": "string",
"is_sponsor": true
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Body

Samples​


Powered by VitePress OpenAPI

Built with VitePress