0

Update Brand

by
Published Apr 8, 2025

Update a brand's attributes by `brandId`.

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 Brand
7
 * Update a brand's attributes by `brandId`.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	brandId: string,
12
	body: {
13
		entityType: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'SOLE_PROPRIETOR' | 'GOVERNMENT'
14
		displayName: string
15
		companyName?: string
16
		firstName?: string
17
		lastName?: string
18
		ein?: string
19
		phone?: string
20
		street?: string
21
		city?: string
22
		state?: string
23
		postalCode?: string
24
		country: string
25
		email: string
26
		stockSymbol?: string
27
		stockExchange?:
28
			| 'NONE'
29
			| 'NASDAQ'
30
			| 'NYSE'
31
			| 'AMEX'
32
			| 'AMX'
33
			| 'ASX'
34
			| 'B3'
35
			| 'BME'
36
			| 'BSE'
37
			| 'FRA'
38
			| 'ICEX'
39
			| 'JPX'
40
			| 'JSE'
41
			| 'KRX'
42
			| 'LON'
43
			| 'NSE'
44
			| 'OMX'
45
			| 'SEHK'
46
			| 'SSE'
47
			| 'STO'
48
			| 'SWX'
49
			| 'SZSE'
50
			| 'TSX'
51
			| 'TWSE'
52
			| 'VSE'
53
		ipAddress?: string
54
		website?: string
55
		vertical:
56
			| 'GOVERNMENT'
57
			| 'REAL_ESTATE'
58
			| 'HEALTHCARE'
59
			| 'ENERGY'
60
			| 'ENTERTAINMENT'
61
			| 'RETAIL'
62
			| 'AGRICULTURE'
63
			| 'INSURANCE'
64
			| 'EDUCATION'
65
			| 'HOSPITALITY'
66
			| 'FINANCIAL'
67
			| 'GAMBLING'
68
			| 'CONSTRUCTION'
69
			| 'NGO'
70
			| 'MANUFACTURING'
71
			| 'TECHNOLOGY'
72
			| 'COMMUNICATION'
73
		altBusiness_id?: string
74
		altBusinessIdType?: 'NONE' | 'DUNS' | 'GIIN' | 'LEI'
75
		isReseller?: false | true
76
		identityStatus?: 'VERIFIED' | 'UNVERIFIED' | 'SELF_DECLARED' | 'VETTED_VERIFIED'
77
		businessContactEmail?: string
78
		webhookURL?: string
79
		webhookFailoverURL?: string
80
	}
81
) {
82
	const url = new URL(`https://api.telnyx.com/v2/brand/${brandId}`)
83

84
	const response = await fetch(url, {
85
		method: 'PUT',
86
		headers: {
87
			'Content-Type': 'application/json',
88
			Authorization: 'Bearer ' + auth.apiKey
89
		},
90
		body: JSON.stringify(body)
91
	})
92
	if (!response.ok) {
93
		const text = await response.text()
94
		throw new Error(`${response.status} ${text}`)
95
	}
96
	return await response.json()
97
}
98