Skip to content

Save add-flow fields​

PATCH
/nonprofits/{id}/onboarding

Any of {step, title, attestation} and the page settings fields (validated as Settings), links replaced as a list.

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 non-profit's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"display_name": "string",
"logo": "string",
"banner_image": "string",
"place": {
"place_id": "string"
},
"cause": "string",
"mission": "string",
"website": "string",
"contact_email": "string",
"contact_email_public": true,
"address": "string",
"founded_year": 0,
"receipt_signer_name": "string",
"receipt_signer_title": "string",
"receipt_thank_you": "string",
"year_end_summary": true,
"general_fund_enabled": true,
"general_fund_visibility": "string",
"monthly_gifts_enabled": true,
"links": [
],
"step": 0,
"title": "string",
"attestation": true
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress