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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create child organization — request body — body data The request payload. |
Referenced models: Create child organization — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create child organization — 201 response body |
Referenced models: Create child organization — 201 response body
Schemas
Section titled “Schemas”Create child organization — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request payload. |
child_admins | array | Optional | People from the child organization to add as its admins. Each person receives an invite to the child organization. |
child_admins[] | Model | Each item | Expand Create child organization — request body — body data child admins item |
child_organization | Model | Required within parent | Expand 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_emails | array | Optional | More 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[] | string | Each item | Format: email Maximum length: 255 |
parent_organization | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A person from the child organization who becomes one of its admins. |
email | string | Required within parent | The email of the person from the child organization. Format: email Maximum length: 255 |
first_name | string | Required within parent | The first name of the person from the child organization. Maximum length: 100 |
last_name | string | Required within parent | The last name of the person from the child organization. Maximum length: 100 |
Create child organization — request body — body data child organization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The object that contains all the information related to the child organization that will be created. |
department | string | Optional | The department's name where the manager will be added. Defaults to "Founder" when omitted. Default: Founder Maximum length: 255 |
headquarters_country | string | Optional | The 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_enabled | boolean | Optional | The flag that enables the public API for the child organization. Defaults to false when omitted. Default: false |
name | string | Required within parent | The organization's name. Maximum length: 255 |
workforce_size | integer | Optional | The workforce size of the child organization. Maximum: 1000000 Minimum: 1 |
Create child organization — request body — body data parent organization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The object that contains the information related to the parent_organization. |
admin_email | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | When the created child organization was created (ISO 8601 format) Format: date-time |
id | string | Required within parent | The unique identifier of the created child organization. |
token | string | Required within parent | The API token generated for the created child organization |
updated_at | string | Required within parent | When the created child organization was updated for the last time (ISO 8601 format) Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}