0

Update an External Connection

by
Published Apr 8, 2025

Updates settings of an existing External Connection based on the parameters of the request.

Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * Update an External Connection
7
 * Updates settings of an existing External Connection based on the parameters of the request.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	id: string,
12
	body: {
13
		active?: false | true
14
		webhook_event_url?: string
15
		webhook_event_failover_url?: string
16
		webhook_timeout_secs?: number
17
		inbound?: { channel_limit?: number }
18
		outbound?: { channel_limit?: number; outbound_voice_profile_id?: string }
19
	}
20
) {
21
	const url = new URL(`https://api.telnyx.com/v2/external_connections/${id}`)
22

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