Deel: Request contract resignation

← eor_worker_offboarding operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.eorworkeroffboarding_createemployeeresignation

Provider route: POST /eor/contracts/{contract_id}/offboarding/resignation. Alter supplies the connection’s credentials and routing.

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["eorWorkerOffboarding"]["createEmployeeResignation"]>[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.eorWorkerOffboarding.createEmployeeResignation(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.eor_worker_offboarding.create_employee_resignation(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.contract_id	string	Required within parent
body	object	Optional
body.data	object	Required within parent
body.data.additional_reason	JSON	Optional	An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY
body.data.additional_reason (oneOf 1)	string	Alternative	An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY One of: MOVING_TO_INTERNAL_ENTITY_WITH_DEEL_GLOBAL_PAYROLL, MOVING_TO_INTERNAL_ENTITY_WITH_OTHER_PROVIDER
body.data.additional_reason (oneOf 2)	null	Alternative
body.data.attachments	JSON	Optional	This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents
body.data.attachments (anyOf 1)	object	Alternative	Additional keys: not allowed
body.data.attachments (anyOf 1).filename	string	Required within parent	Minimum length: 1
body.data.attachments (anyOf 1).content_type	string	Required within parent	Minimum length: 1
body.data.attachments (anyOf 1).content_base64	string	Required within parent
body.data.attachments (anyOf 2)	array	Alternative	Minimum items: 1
body.data.attachments (anyOf 2)[]	object	Each item	Additional keys: not allowed
body.data.attachments (anyOf 2)[].filename	string	Required within parent	Minimum length: 1
body.data.attachments (anyOf 2)[].content_type	string	Required within parent	Minimum length: 1
body.data.attachments (anyOf 2)[].content_base64	string	Required within parent
body.data.desired_end_date	string	Optional	The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Format: date
body.data.eligible_for_rehire	JSON	Optional	Parameter to inform whether it would be possible for the client to hire the employee again
body.data.eligible_for_rehire (oneOf 1)	string	Alternative	Parameter to inform whether it would be possible for the client to hire the employee again One of: YES, NO, DONT_KNOW
body.data.eligible_for_rehire (oneOf 2)	null	Alternative
body.data.eligible_for_rehire_reason	string or null	Optional	Describe if the option DONT_KNOW was selected on eligible_for_rehire Maximum length: 255
body.data.is_employee_staying_with_deel	boolean or null	Required within parent	Defines if employee will keep using Deel as provider
body.data.is_sensitive	boolean	Optional	Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications.
body.data.reason	string	Required within parent	Reason why the contract is being terminated One of: EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY, MOVING_EMPLOYEE_TO_INTERNAL_ENTITY, MOVING_EMPLOYEE_TO_DEEL_PEO, EMPLOYEE_FOUND_ANOTHER_JOB, EMPLOYEE_NOT_HAPPY_WITH_BENEFITS, EMPLOYEE_NOT_HAPPY_WITH_SALARY, EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE, EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE, EMPLOYEE_NOT_HAPPY_WITH_DEEL, EMPLOYEE_PROJECT_ENDED, EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER, EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS, EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE, WORKER_TYPE_CHANGE, DEEL_COLLECTIONS, EMPLOYEE_DID_NOT_TAKE_THE_OFFER, EMPLOYEE_PROVIDED_NO_REASON, OTHER_BUSINESS_REASONS
body.data.reason_detail	string	Optional	Optional field to describe the reason behind the resignation request Maximum length: 5000
body.data.severance_amount	string	Optional	The amount of severance needed
body.data.severance_type	string	Optional	The type of severance selected by the client. It’s an optional field One of: DAYS, WEEKS, MONTHS, CASH
body.data.termination_notes	array	Optional	Additional notes can be provided regarding the termination for Deel, like questions and doubts Default: []
body.data.termination_notes[]	string	Each item	Maximum length: 5000
body.data.used_time_off	Model	Required within parent	Expand Request contract resignation — request body — body data used time off

Referenced models: Request contract resignation — request body — body data used time off

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 Request contract resignation — 201 response body

Referenced models: Request contract resignation — 201 response body

Policy, approvals and errors

SDK function policy ID: deel.eorworkeroffboarding_createemployeeresignation. Catalog operation: eorworkeroffboarding_createemployeeresignation. 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: ["contracts:write"]

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

Official provider source