0

Configure custom data type

by
Published Oct 17, 2025

The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration.

Script codat Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Codat = {
3
	encodedKey: string
4
}
5
/**
6
 * Configure custom data type
7
 * The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration.
8
 */
9
export async function main(
10
	auth: Codat,
11
	platformKey: string,
12
	customDataIdentifier: string,
13
	body: {
14
		dataSource?: string
15
		requiredData?: {}
16
		keyBy?: string[]
17
		sourceModifiedDate?: string[]
18
	}
19
) {
20
	const url = new URL(
21
		`https://api.codat.io/integrations/${platformKey}/dataTypes/custom/${customDataIdentifier}`
22
	)
23

24
	const response = await fetch(url, {
25
		method: 'PUT',
26
		headers: {
27
			'Content-Type': 'application/json',
28
			Authorization: `Basic ${auth.encodedKey}`
29
		},
30
		body: JSON.stringify(body)
31
	})
32
	if (!response.ok) {
33
		const text = await response.text()
34
		throw new Error(`${response.status} ${text}`)
35
	}
36
	return await response.json()
37
}
38