0

Share a porting order

by
Published Apr 8, 2025

Creates a sharing apiKey for a porting order. The apiKey can be used to share the porting order with non-Telnyx users.

Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * Share a porting order
7
 * Creates a sharing apiKey for a porting order. The apiKey can be used to share the porting order with non-Telnyx users.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	id: string,
12
	body: {
13
		expires_in_seconds?: number
14
		permissions?: 'porting_order.document.read' | 'porting_order.document.update'
15
	}
16
) {
17
	const url = new URL(`https://api.telnyx.com/v2/porting_orders/${id}/actions/share`)
18

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