Skip to content

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​

Powered by VitePress OpenAPI

Built with VitePress