Skip to content

Create a child organization​

POST
/org-admin/{slug}/children

Creates a new company under this conglomerate. Validation is the same as POST /organizations, except that the new organization is always a company (kind is ignored once it passes validation) and sending parent_organization_id in the body is rejected — the parent is always the {slug} organization. The caller becomes org_owner of the child. The child starts with verification_status: pending; the first DBA becomes its default and the first location its primary.

Requires a verified email address.

Requires permission: org.manage_children (organization owners only)

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

slug*

The organization's slug (not its UUID).

Type
string
Required
Example"local-food-bank-a1b2c3"
Pattern
"^[a-z0-9][a-z0-9-]{0,254}$"

Request Body​

application/json
JSON
{
"legal_name": "string",
"ein": "12-3456789",
"country": "string",
"website": "string",
"description": "string",
"categories": [
"string"
],
"dbas": [
{
"dba_name": "string"
}
],
"locations": [
{
"label": "string",
"address": "string"
}
]
}

Responses​

Child organization created

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

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress