For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Support Deel Home

Overview Platform Employer of Record Contractors Global Payroll HR Embedded Deel IT API Reference Changelog

Skip to navigation

This page is for API, version 2026-01-01 (Stable) (default). For other versions, use one of these documentation indexes: - 2026-01-01 (Stable) (default): https://docs.deel.wtf/api/stable/llms.txt

HRIS Endpoints Worker Relations

Update Worker Relation Type By External Id

PATCH

/hris/worker_relations/types/external/:externalId

PATCH

/rest/hris/worker_relations/types/external/:externalId

curl -X PATCH https://api.letsdeel.com/rest/hris/worker_relations/types/external/externalId

200Updated

Path parameters

externalIdstringRequired

Was this page helpful?

ATS introduction

Overview Platform Employer of Record Contractors Global Payroll HR Embedded Deel IT API Reference Changelog

Resources
HRIS Guides
- Introduction
HRIS Common Use Cases
- Sync Deel users to identity providers
SCIM API
- Overview
HRIS Endpoints
ATS Guides
ATS Common Use Cases
- From candidate to contract
ATS Endpoints

Introduction
Sync Deel users to identity providers
Overview
Delete Contract custom field by Id
Get custom fields from contracts
List all custom fields
Retrieve custom fields for a contract
Update custom field value
Delete the custom field value from Worker by Id
Get custom field from people by id
List all people custom fields
Retrieve custom fields for a worker
Update custom field value
Event: Employee Created Contractor
Event: Employee Created Direct
Event: Employee Created EOR
Event: Employee Updated Direct
Event: Worker Created (SCIM)
Event: Worker V2 Created
Event: Worker V2 Deleted
Event: Worker V2 Updated
Organization Structure
Create a new HRIS Organization Structure.
Delete an Org Structure from the Organization
Delete an Org Structure from the Organization by external ID
Get Organization Structure
Get Organization Structure by External ID
Get Organization Structures
Update an existing HRIS Org Structure
Update an existing HRIS Org Structure by external ID
Update organization structure
Update Team Custom Fields
People
Create a person without a contract
List of People
Retrieve a single person
Update working location
Get personal information by id
Get worker profile by external ID
Profiles
Update personal information
Update personal information by external id
Positions
Apply changes to positions.
Get Positions by Profile
Time Off
Approve or reject time-off requests
Cancel time-off request
Create time-off request
Event: Time Off Created
Event: Time Off Deleted
Event: Time Off Reviewed
Event: Time Off Updated
Get Profile Entitlements
Get Time Off Events for Profile
Get Work Schedule and Holidays
List policies
List time-off requests
Process time-off requests from an external HRIS
Retrieve policy validation templates
Update time-off request
Validate time-off request
List users
Retrieve a single User
Worker Relations
Add Worker Relation Child By External Id
Add Worker Relation Parent
Create a parent worker relation with external id
Create a worker relation
Create child worker relation
Create worker relation type
Create worker relation with external Ids
Delete a worker relation type
Delete Worker Relation Profile
Delete Worker Relation Profile By External Id
Delete Worker Relation Type By External Id
Fetch Worker Relations of a given HrisProfile by external id
Get Worker Relation Profile
Retrieve all worker relation types
Update Worker Relation Type
Update Worker Relation Type By External Id
Introduction
Getting started
Manage jobs
Manage candidates and applications
Webhooks
From candidate to contract
Retrieve a list of ATS application sources
Add note to an application
Retrieve a list of ATS applications
Create ATS Application
Assign application to interview plan stage
Retrieve ATS application
Event: ATS Application Created
Event: ATS Application Transitioned
Retrieve paginated list of ATS attachment files
Create candidate tags
Retrieve paginated list of ATS Candidates
Create ATS Candidate
Retrieve a list of ATS departments
Retrieve a list of published ATS email templates
Retrieve a list of ATS employment types
Retrieve ATS hiring members
Retrieve ATS job postings
Retrieve a list of ATS job postings
Retrieve ATS job posting
Event: ATS Job Posting Publication Created
Event: ATS Job Posting Updated
Event: ATS Job Posting Created
Event: ATS Job Posting Publication Updated
Retrieve a list of ATS jobs
Create ATS Job
Retrieve a list of ATS locations
Retrieve a list of ATS offers
Retrieve paginated list of ATS Rejection/Archivation reasons
List candidate tags of the organization

API
MCP Server
CLI

2026-01-01 (Stable)