0

UpdateTeamMember

by
Published Oct 17, 2025

Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member).

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * UpdateTeamMember
7
 * Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates.
8
Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member).
9
 */
10
export async function main(
11
  auth: Square,
12
  team_member_id: string,
13
  body: {
14
    team_member?: {
15
      id?: string;
16
      reference_id?: string;
17
      is_owner?: false | true;
18
      status?: "ACTIVE" | "INACTIVE";
19
      given_name?: string;
20
      family_name?: string;
21
      email_address?: string;
22
      phone_number?: string;
23
      created_at?: string;
24
      updated_at?: string;
25
      assigned_locations?: {
26
        assignment_type?:
27
          | "ALL_CURRENT_AND_FUTURE_LOCATIONS"
28
          | "EXPLICIT_LOCATIONS";
29
        location_ids?: string[];
30
      };
31
      wage_setting?: {
32
        team_member_id?: string;
33
        job_assignments?: {
34
          job_title?: string;
35
          pay_type: "NONE" | "HOURLY" | "SALARY";
36
          hourly_rate?: {
37
            amount?: number;
38
            currency?:
39
              | "UNKNOWN_CURRENCY"
40
              | "AED"
41
              | "AFN"
42
              | "ALL"
43
              | "AMD"
44
              | "ANG"
45
              | "AOA"
46
              | "ARS"
47
              | "AUD"
48
              | "AWG"
49
              | "AZN"
50
              | "BAM"
51
              | "BBD"
52
              | "BDT"
53
              | "BGN"
54
              | "BHD"
55
              | "BIF"
56
              | "BMD"
57
              | "BND"
58
              | "BOB"
59
              | "BOV"
60
              | "BRL"
61
              | "BSD"
62
              | "BTN"
63
              | "BWP"
64
              | "BYR"
65
              | "BZD"
66
              | "CAD"
67
              | "CDF"
68
              | "CHE"
69
              | "CHF"
70
              | "CHW"
71
              | "CLF"
72
              | "CLP"
73
              | "CNY"
74
              | "COP"
75
              | "COU"
76
              | "CRC"
77
              | "CUC"
78
              | "CUP"
79
              | "CVE"
80
              | "CZK"
81
              | "DJF"
82
              | "DKK"
83
              | "DOP"
84
              | "DZD"
85
              | "EGP"
86
              | "ERN"
87
              | "ETB"
88
              | "EUR"
89
              | "FJD"
90
              | "FKP"
91
              | "GBP"
92
              | "GEL"
93
              | "GHS"
94
              | "GIP"
95
              | "GMD"
96
              | "GNF"
97
              | "GTQ"
98
              | "GYD"
99
              | "HKD"
100
              | "HNL"
101
              | "HRK"
102
              | "HTG"
103
              | "HUF"
104
              | "IDR"
105
              | "ILS"
106
              | "INR"
107
              | "IQD"
108
              | "IRR"
109
              | "ISK"
110
              | "JMD"
111
              | "JOD"
112
              | "JPY"
113
              | "KES"
114
              | "KGS"
115
              | "KHR"
116
              | "KMF"
117
              | "KPW"
118
              | "KRW"
119
              | "KWD"
120
              | "KYD"
121
              | "KZT"
122
              | "LAK"
123
              | "LBP"
124
              | "LKR"
125
              | "LRD"
126
              | "LSL"
127
              | "LTL"
128
              | "LVL"
129
              | "LYD"
130
              | "MAD"
131
              | "MDL"
132
              | "MGA"
133
              | "MKD"
134
              | "MMK"
135
              | "MNT"
136
              | "MOP"
137
              | "MRO"
138
              | "MUR"
139
              | "MVR"
140
              | "MWK"
141
              | "MXN"
142
              | "MXV"
143
              | "MYR"
144
              | "MZN"
145
              | "NAD"
146
              | "NGN"
147
              | "NIO"
148
              | "NOK"
149
              | "NPR"
150
              | "NZD"
151
              | "OMR"
152
              | "PAB"
153
              | "PEN"
154
              | "PGK"
155
              | "PHP"
156
              | "PKR"
157
              | "PLN"
158
              | "PYG"
159
              | "QAR"
160
              | "RON"
161
              | "RSD"
162
              | "RUB"
163
              | "RWF"
164
              | "SAR"
165
              | "SBD"
166
              | "SCR"
167
              | "SDG"
168
              | "SEK"
169
              | "SGD"
170
              | "SHP"
171
              | "SLL"
172
              | "SLE"
173
              | "SOS"
174
              | "SRD"
175
              | "SSP"
176
              | "STD"
177
              | "SVC"
178
              | "SYP"
179
              | "SZL"
180
              | "THB"
181
              | "TJS"
182
              | "TMT"
183
              | "TND"
184
              | "TOP"
185
              | "TRY"
186
              | "TTD"
187
              | "TWD"
188
              | "TZS"
189
              | "UAH"
190
              | "UGX"
191
              | "USD"
192
              | "USN"
193
              | "USS"
194
              | "UYI"
195
              | "UYU"
196
              | "UZS"
197
              | "VEF"
198
              | "VND"
199
              | "VUV"
200
              | "WST"
201
              | "XAF"
202
              | "XAG"
203
              | "XAU"
204
              | "XBA"
205
              | "XBB"
206
              | "XBC"
207
              | "XBD"
208
              | "XCD"
209
              | "XDR"
210
              | "XOF"
211
              | "XPD"
212
              | "XPF"
213
              | "XPT"
214
              | "XTS"
215
              | "XXX"
216
              | "YER"
217
              | "ZAR"
218
              | "ZMK"
219
              | "ZMW"
220
              | "BTC"
221
              | "XUS";
222
          };
223
          annual_rate?: {
224
            amount?: number;
225
            currency?:
226
              | "UNKNOWN_CURRENCY"
227
              | "AED"
228
              | "AFN"
229
              | "ALL"
230
              | "AMD"
231
              | "ANG"
232
              | "AOA"
233
              | "ARS"
234
              | "AUD"
235
              | "AWG"
236
              | "AZN"
237
              | "BAM"
238
              | "BBD"
239
              | "BDT"
240
              | "BGN"
241
              | "BHD"
242
              | "BIF"
243
              | "BMD"
244
              | "BND"
245
              | "BOB"
246
              | "BOV"
247
              | "BRL"
248
              | "BSD"
249
              | "BTN"
250
              | "BWP"
251
              | "BYR"
252
              | "BZD"
253
              | "CAD"
254
              | "CDF"
255
              | "CHE"
256
              | "CHF"
257
              | "CHW"
258
              | "CLF"
259
              | "CLP"
260
              | "CNY"
261
              | "COP"
262
              | "COU"
263
              | "CRC"
264
              | "CUC"
265
              | "CUP"
266
              | "CVE"
267
              | "CZK"
268
              | "DJF"
269
              | "DKK"
270
              | "DOP"
271
              | "DZD"
272
              | "EGP"
273
              | "ERN"
274
              | "ETB"
275
              | "EUR"
276
              | "FJD"
277
              | "FKP"
278
              | "GBP"
279
              | "GEL"
280
              | "GHS"
281
              | "GIP"
282
              | "GMD"
283
              | "GNF"
284
              | "GTQ"
285
              | "GYD"
286
              | "HKD"
287
              | "HNL"
288
              | "HRK"
289
              | "HTG"
290
              | "HUF"
291
              | "IDR"
292
              | "ILS"
293
              | "INR"
294
              | "IQD"
295
              | "IRR"
296
              | "ISK"
297
              | "JMD"
298
              | "JOD"
299
              | "JPY"
300
              | "KES"
301
              | "KGS"
302
              | "KHR"
303
              | "KMF"
304
              | "KPW"
305
              | "KRW"
306
              | "KWD"
307
              | "KYD"
308
              | "KZT"
309
              | "LAK"
310
              | "LBP"
311
              | "LKR"
312
              | "LRD"
313
              | "LSL"
314
              | "LTL"
315
              | "LVL"
316
              | "LYD"
317
              | "MAD"
318
              | "MDL"
319
              | "MGA"
320
              | "MKD"
321
              | "MMK"
322
              | "MNT"
323
              | "MOP"
324
              | "MRO"
325
              | "MUR"
326
              | "MVR"
327
              | "MWK"
328
              | "MXN"
329
              | "MXV"
330
              | "MYR"
331
              | "MZN"
332
              | "NAD"
333
              | "NGN"
334
              | "NIO"
335
              | "NOK"
336
              | "NPR"
337
              | "NZD"
338
              | "OMR"
339
              | "PAB"
340
              | "PEN"
341
              | "PGK"
342
              | "PHP"
343
              | "PKR"
344
              | "PLN"
345
              | "PYG"
346
              | "QAR"
347
              | "RON"
348
              | "RSD"
349
              | "RUB"
350
              | "RWF"
351
              | "SAR"
352
              | "SBD"
353
              | "SCR"
354
              | "SDG"
355
              | "SEK"
356
              | "SGD"
357
              | "SHP"
358
              | "SLL"
359
              | "SLE"
360
              | "SOS"
361
              | "SRD"
362
              | "SSP"
363
              | "STD"
364
              | "SVC"
365
              | "SYP"
366
              | "SZL"
367
              | "THB"
368
              | "TJS"
369
              | "TMT"
370
              | "TND"
371
              | "TOP"
372
              | "TRY"
373
              | "TTD"
374
              | "TWD"
375
              | "TZS"
376
              | "UAH"
377
              | "UGX"
378
              | "USD"
379
              | "USN"
380
              | "USS"
381
              | "UYI"
382
              | "UYU"
383
              | "UZS"
384
              | "VEF"
385
              | "VND"
386
              | "VUV"
387
              | "WST"
388
              | "XAF"
389
              | "XAG"
390
              | "XAU"
391
              | "XBA"
392
              | "XBB"
393
              | "XBC"
394
              | "XBD"
395
              | "XCD"
396
              | "XDR"
397
              | "XOF"
398
              | "XPD"
399
              | "XPF"
400
              | "XPT"
401
              | "XTS"
402
              | "XXX"
403
              | "YER"
404
              | "ZAR"
405
              | "ZMK"
406
              | "ZMW"
407
              | "BTC"
408
              | "XUS";
409
          };
410
          weekly_hours?: number;
411
          job_id?: string;
412
        }[];
413
        is_overtime_exempt?: false | true;
414
        version?: number;
415
        created_at?: string;
416
        updated_at?: string;
417
      };
418
    };
419
  },
420
) {
421
  const url = new URL(
422
    `https://connect.squareup.com/v2/team-members/${team_member_id}`,
423
  );
424

425
  const response = await fetch(url, {
426
    method: "PUT",
427
    headers: {
428
      "Content-Type": "application/json",
429
      Authorization: "Bearer " + auth.token,
430
    },
431
    body: JSON.stringify(body),
432
  });
433
  if (!response.ok) {
434
    const text = await response.text();
435
    throw new Error(`${response.status} ${text}`);
436
  }
437
  return await response.json();
438
}
439