Skip to content

Deel: Create child organization

Deel organizations.createOrganizationChild: arguments, response, policy and SDK examples.

← Organizations operations · Get started

Operation deel.organizations_createorganizationchild

Provider route: POST /organizations/children. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["organizations"]["createOrganizationChild"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.organizations.createOrganizationChild(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.organizations.create_organization_child(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Create child organization — request body — body data
The request payload.

Referenced models: Create child organization — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create child organization — 201 response body

Referenced models: Create child organization — 201 response body

Create child organization — request body — body data
FieldTypePresenceDescription and constraints
$objectRootThe request payload.
child_adminsarrayOptionalPeople from the child organization to add as its admins. Each person receives an invite to the child organization.
child_admins[]ModelEach itemExpand Create child organization — request body — body data child admins item
child_organizationModelRequired within parentExpand Create child organization — request body — body data child organization
The object that contains all the information related to the child organization that will be created.
parent_admin_emailsarrayOptionalMore admins of the parent organization to add as admins of the child organization, as the Partner Portal create form does. Every email must belong to an existing admin of the parent organization, otherwise creation fails and no child organization is created. Each admin receives an invite to the child organization.
parent_admin_emails[]stringEach itemFormat: email
Maximum length: 255
parent_organizationModelRequired within parentExpand Create child organization — request body — body data parent organization
The object that contains the information related to the parent_organization.

Referenced models: Create child organization — request body — body data child admins item, Create child organization — request body — body data child organization, Create child organization — request body — body data parent organization

Create child organization — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create child organization — 201 response body — data

Referenced models: Create child organization — 201 response body — data

Create child organization — request body — body data child admins item
FieldTypePresenceDescription and constraints
$objectRootA person from the child organization who becomes one of its admins.
emailstringRequired within parentThe email of the person from the child organization.
Format: email
Maximum length: 255
first_namestringRequired within parentThe first name of the person from the child organization.
Maximum length: 100
last_namestringRequired within parentThe last name of the person from the child organization.
Maximum length: 100
Create child organization — request body — body data child organization
FieldTypePresenceDescription and constraints
$objectRootThe object that contains all the information related to the child organization that will be created.
departmentstringOptionalThe department's name where the manager will be added. Defaults to "Founder" when omitted.
Default: Founder
Maximum length: 255
headquarters_countrystringOptionalThe organization's headquarters country as an ISO 3166-1 alpha-2 code. Validated against Deel's country whitelist; unknown codes are rejected.
Maximum length: 2
Minimum length: 2
is_api_enabledbooleanOptionalThe flag that enables the public API for the child organization. Defaults to false when omitted.
Default: false
namestringRequired within parentThe organization's name.
Maximum length: 255
workforce_sizeintegerOptionalThe workforce size of the child organization.
Maximum: 1000000
Minimum: 1
Create child organization — request body — body data parent organization
FieldTypePresenceDescription and constraints
$objectRootThe object that contains the information related to the parent_organization.
admin_emailstringRequired within parentThe email of one of the managers of the parent organization. It must belong to an existing admin/manager of the parent organization, otherwise creation fails. This manager is the user that creates the child organization.
Format: email
Create child organization — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentWhen the created child organization was created (ISO 8601 format)
Format: date-time
idstringRequired within parentThe unique identifier of the created child organization.
tokenstringRequired within parentThe API token generated for the created child organization
updated_atstringRequired within parentWhen the created child organization was updated for the last time (ISO 8601 format)
Format: date-time

SDK function policy ID: deel.organizations_createorganizationchild. Catalog operation: organizations/create-child. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Refused by default. This operation leaves the caller holding a credential (the new child organization’s permanent API token, returned once), so Alter refuses it on every connection with credential_minting_refused unless an organization admin allows it: a credential_minting rule naming provider deel and operation deel.organizations_createorganizationchild (or organizations/create-child). See Allow an operation that hands over a credential.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["organizations:write"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.