Skip to content

Deel: Edit a legal entity

Deel legalEntities.updateLegalEntity: arguments, response, policy and SDK examples.

← Legal entities operations · Get started

Operation deel.legalentities_updatelegalentity

Provider route: PATCH /legal-entities/{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["legalEntities"]["updateLegalEntity"]>[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.legalEntities.updateLegalEntity(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.legal_entities.update_legal_entity(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parent
bodyobjectOptional
body.dataModelOptionalExpand Edit a legal entity — request body — body data

Referenced models: Edit a legal entity — 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 Edit a legal entity — 200 response body

Referenced models: Edit a legal entity — 200 response body

Edit a legal entity — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Edit a legal entity — request body — body data address
company_identifiersModelOptionalExpand Edit a legal entity — request body — body data company identifiers
Identifiers associated with the legal entity.
deel_industry_subcategory_idstringOptionalReference to the Deel Industry Code (NAICS).
entity_typestringOptionalThe type of the legal entity.
industry_namestringOptionalThe industry name of the legal entity.
namestringOptionalThe name of the legal entity.
phonestringOptionalThe phone number of the legal entity.
sic_numberstringOptionalThe SIC number of the legal entity.

Referenced models: Edit a legal entity — request body — body data address, Edit a legal entity — request body — body data company identifiers

Edit a legal entity — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Edit a legal entity — 200 response body — data

Referenced models: Edit a legal entity — 200 response body — data

Edit a legal entity — request body — body data address
FieldTypePresenceDescription and constraints
$objectRoot
citystringOptionalThe city.
countrystringOptionalThe ISO 2-letter country code.
Pattern: ^[A-Z]{2}$
statestringOptionalThe state.
streetstringOptionalThe street address.
Edit a legal entity — request body — body data company identifiers
FieldTypePresenceDescription and constraints
$objectRootIdentifiers associated with the legal entity.
registration_numberstringOptionalThe registration number of the legal entity.
tax_numberstringOptionalThe tax identification number of the legal entity.
Edit a legal entity — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Edit a legal entity — 200 response body — data address
company_identifiersModelOptionalExpand Edit a legal entity — 200 response body — data company identifiers
entity_typestringOptionalThe type of the legal entity.
idstringOptionalThe unique identifier of the legal entity.
industry_namestringOptionalThe industry name of the legal entity.
namestringOptionalThe name of the legal entity.
phonestringOptionalThe phone number of the legal entity.
sic_numberstringOptionalThe SIC number of the legal entity.

Referenced models: Edit a legal entity — 200 response body — data address, Edit a legal entity — 200 response body — data company identifiers

Edit a legal entity — 200 response body — data address
FieldTypePresenceDescription and constraints
$objectRoot
citystringOptionalThe city.
countrystringOptionalThe ISO 2-letter country code.
statestringOptionalThe state.
streetstringOptionalThe street address.
Edit a legal entity — 200 response body — data company identifiers
FieldTypePresenceDescription and constraints
$objectRoot
registration_numberstringOptionalThe registration number of the legal entity.
tax_numberstringOptionalThe tax identification number of the legal entity.

SDK function policy ID: deel.legalentities_updatelegalentity. Catalog operation: legalentities_updatelegalentity. 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: ["legal-entity: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.