Skip to content

Resources · Fundraisers​

A fundraiser naming the help it raises money for ("Help we're raising for"), the provider's confirmation, direct payout and My help (#2424). A visitor sees confirmed links only; the fundraiser's organizer (its owner, as PATCH /fundraisers/{id} decides it) also sees requested, needs_confirmation and declined links, never a decline's reason. Where gifts go is always read from the fundraiser's own beneficiary (the columns checkout reads), never from a flag: "Send gifts straight to" changes that beneficiary to the provider's non-profit through the existing non-profit beneficiary path, and a transfer, merge or decline never touches it. Every operation answers 403 while Resources are switched off (features.resources).


Help we're raising for​

GET
/fundraisers/{id}/resources

What the fundraiser shows under "Help we're raising for". A visitor sees confirmed links only: the provider's public card, the help's name, the estimate and "Confirmed by "; a business link reads "The organizer pays the business" (giftsGoTo: organizer). The fundraiser's owner and admins get the organizer's view: also requested, needs_confirmation and declined links, with the payout state. A fundraiser the caller may not open answers 404, as GET /fundraisers/{id} does. A visitor's answer may be cached for a minute; anyone signed in gets private, no-store.

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

id*

The fundraiser.

Type
string
Required
Format
"uuid"

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​


Name help on a fundraiser​

POST
/fundraisers/{id}/resources

The fundraiser's organizer names live, publicly listed help with a fee, and an estimate. Help in a licensed topic (a lawyer) needs client_consent: true (the organizer agrees the provider may confirm they are its client), recorded as the link's consent; consent given for other help is recorded too. One link per fundraiser and help: a repeat answers 409 already_named with details.link_id. The provider's managers get a bell (Resources) and fundraiser_resource.requested is published after the commit. The link waits on the provider: a reminder at 7 days, removed at 14 if unanswered.

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

id*

The fundraiser.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"resource_id": "string",
"estimate_cents": 0,
"client_consent": true
}

Responses​

Named. The new link and the organizer's whole view.

application/json
JSON
{
"link": "string",
"view": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Remove help from a fundraiser​

DELETE
/fundraisers/{id}/resources/{linkId}

The organizer (or an admin) removes a link: it stays on record as removed and fundraiser_resource.removed is published. Removing a removed link answers the same. While this link holds "Send gifts straight to", 409 payout_on: turn that off 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

id*

The fundraiser.

Type
string
Required
Format
"uuid"
linkId*
Type
string
Required
Format
"uuid"

Responses​

Removed.

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

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Send the provider a reminder​

POST
/fundraisers/{id}/resources/{linkId}/remind

The fundraiser's organizer nudges a provider that hasn't answered (board FrPagePending): only while the link is requested (409 not_waiting once it answered), and at most once every 3 days (429 nudge_too_soon with details.next_at). The provider's managers get a bell; the help is never named on a sensitive topic. Audited (fundraiser_resource.nudged). Answers the organizer's view.

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

id*

The fundraiser.

Type
string
Required
Format
"uuid"
linkId*

The link.

Type
string
Required
Format
"uuid"

Responses​

Sent. The organizer's view, with when the next reminder can go.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Send gifts straight to the provider​

PUT
/fundraisers/{id}/resources/{linkId}/payout

The fundraiser's owner turns direct payout on or off. It is not a flag: turning it on changes the fundraiser's own beneficiary (beneficiary_type nonprofit, org_id the provider's non-profit, type charity), the existing non-profit beneficiary path checkout reads on every gift, in one transaction with the link, and remembers the previous beneficiary; turning it off restores exactly that. On needs a confirmed link (link_not_confirmed) to an active (provider_not_active) non-profit or church (a business or community: 422 payout_not_offered), a fundraiser not already raising for a non-profit (already_nonprofit), no waiting beneficiary invitation (beneficiary_invitation_pending), a linked person when raising for someone else (beneficiary_person_required), and the non-profit path's own checks: verified (nonprofit_not_verified), USD, no account deletion hold (account_deletion_hold) and a payout account that can receive money now (nonprofit_account_not_ready, payments_disabled). After the first gift or payment, both directions answer 409 payout_locked. A transfer, merge or decline later leaves the beneficiary as it is; off still works from that link while nothing is locked. Idempotent.

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

id*

The fundraiser.

Type
string
Required
Format
"uuid"
linkId*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"on": true
}

Responses​

The organizer's view after the change.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


My help​

GET
/me/help

The signed-in person's My help summary, which only they see: the providers they saved (newest first, up to 50), their fundraisers that name help with where gifts go and each link as the organizer sees it (up to 20), and up to 3 open free stuff items (null while free stuff is off for them). Never cached.

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​


Powered by VitePress OpenAPI

Built with VitePress