Skip to content

Deel: Update an existing HRIS Org Structure

Deel organizationStructure.updateOrganizationStructure: arguments, response, policy and SDK examples.

← Organization structure operations · Get started

Operation deel.organizationstructure_updateorganizationstructure

Provider route: PATCH /hris/organization_structures/{hris_org_structure_id}. 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["organizationStructure"]["updateOrganizationStructure"]>[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.organizationStructure.updateOrganizationStructure(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.organization_structure.update_organization_structure(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.hris_org_structure_idstringRequired within parent
bodyobjectOptional
body.dataModelOptionalExpand Update an existing HRIS Org Structure — request body — body data

Referenced models: Update an existing HRIS Org Structure — 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 Delete Bank Details — 201 response body

Referenced models: Delete Bank Details — 201 response body

Update an existing HRIS Org Structure — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
enable_rolesbooleanOptionalEnable roles for the Org Structure
external_idstringOptionalExternal ID of the Org Structure
is_multiselectbooleanOptionalEnable multiselect for the Org Structure
namestringOptionalName of the Org Structure
teamsarrayRequired within parentTeams to create, update or delete. Items with an id update that team and items without one create a team. A top-level item with only an id deletes that team, which is rejected while the team or its descendants have positions. Teams not listed are left untouched. The parent of a team is expressed by nesting it in children.
teams[]ModelEach itemExpand Update an existing HRIS Org Structure — request body — body data teams item

Referenced models: Update an existing HRIS Org Structure — request body — body data teams item

Delete Bank Details — 201 response body
FieldTypePresenceDescription and constraints
$objectRootEmpty response body
Update an existing HRIS Org Structure — request body — body data teams item
FieldTypePresenceDescription and constraints
$objectRootA team of the org structure, with its child teams nested under it.
childrenarrayOptionalTeams nested under this team. A team is a child of the item it is nested under; teams at the top level of the teams array are root teams.
children[]ModelEach itemExpand Update an existing HRIS Org Structure — request body — body data teams item children item
externalIdstring or nullOptionalExternal ID of the team. To set or clear one team's external ID, use PATCH /rest/hris/organization-structures/teams/{team_id}.
idstringOptionalID of an existing team to update. Omit to create a new team. A top-level item with an id and no name deletes that team.
namestringOptionalName of the team. Required to create or update a team; omit it, and send only the id, to delete the team.

Referenced models: Update an existing HRIS Org Structure — request body — body data teams item children item

Update an existing HRIS Org Structure — request body — body data teams item children item
FieldTypePresenceDescription and constraints
$objectRootA child team, with the same fields as a top-level item, nested to any depth.

SDK function policy ID: deel.organizationstructure_updateorganizationstructure. Catalog operation: organizationstructure_updateorganizationstructure. 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.

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.