0

Update a worker relation type by external id

by
Published Oct 17, 2025

Update a worker relation type by external id. **Token scopes**: `organizations:write`

Script deel Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
/**
3
 * Update a worker relation type by external id
4
 * Update a worker relation type by external id.
5
 **Token scopes**: `organizations:write`
6
 */
7
export async function main(auth: RT.Deel, externalId: string, body: Body) {
8
	const url = new URL(
9
		`https://api.letsdeel.com/rest/v2/hris/worker_relations/types/external/${externalId}`
10
	)
11

12
	const response = await fetch(url, {
13
		method: 'PATCH',
14
		headers: {
15
			'Content-Type': 'application/json',
16
			Authorization: 'Bearer ' + auth.apiKey
17
		},
18
		body: JSON.stringify(body)
19
	})
20
	if (!response.ok) {
21
		const text = await response.text()
22
		throw new Error(`${response.status} ${text}`)
23
	}
24
	return await response.json()
25
}
26

27
/* eslint-disable */
28
/**
29
 * This file was automatically generated by json-schema-to-typescript.
30
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
31
 * and run json-schema-to-typescript to regenerate this file.
32
 */
33

34
export interface Body {
35
	data?: {
36
		/**
37
		 * The name of the secondary party in the relationship
38
		 */
39
		child_name?: string
40
		/**
41
		 * A custom ID for the relation type
42
		 */
43
		external_id?: string
44
		/**
45
		 * The name of the primary party in the relationship
46
		 */
47
		parent_name?: string
48
		[k: string]: unknown
49
	}
50
	[k: string]: unknown
51
}
52