0

Update an attribute

by
Published Oct 17, 2025

Updates a single attribute on a given object or list. Required scopes: `object_configuration:read-write`.

Script attio Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Attio = {
3
  token: string;
4
};
5
/**
6
 * Update an attribute
7
 * Updates a single attribute on a given object or list.
8

9
Required scopes: `object_configuration:read-write`.
10
 */
11
export async function main(
12
  auth: Attio,
13
  target: "objects" | "lists",
14
  identifier: string,
15
  attribute: string,
16
  body: {
17
    data: {
18
      title?: string;
19
      description?: string;
20
      api_slug?: string;
21
      is_required?: false | true;
22
      is_unique?: false | true;
23
      default_value?:
24
        | { type: "dynamic"; template: string }
25
        | {
26
            type: "static";
27
            template:
28
              | {
29
                  referenced_actor_type: "workspace-member";
30
                  referenced_actor_id: string;
31
                }
32
              | { workspace_member_email_address: string }
33
              | { value: false | true }
34
              | { currency_value: number }
35
              | { value: string }
36
              | { domain?: string }
37
              | { email_address?: string }
38
              | { target_object: string; target_record_id: string }
39
              | {
40
                  target_object: string;
41
                  "[slug_or_id_of_matching_attribute]":
42
                    | { domain?: string }
43
                    | { email_address?: string }
44
                    | { value?: number }
45
                    | {
46
                        original_phone_number?: string;
47
                        country_code?:
48
                          | "AF"
49
                          | "AX"
50
                          | "AL"
51
                          | "DZ"
52
                          | "AS"
53
                          | "AD"
54
                          | "AO"
55
                          | "AI"
56
                          | "AQ"
57
                          | "AG"
58
                          | "AR"
59
                          | "AM"
60
                          | "AW"
61
                          | "AU"
62
                          | "AT"
63
                          | "AZ"
64
                          | "BS"
65
                          | "BH"
66
                          | "BD"
67
                          | "BB"
68
                          | "BY"
69
                          | "BE"
70
                          | "BZ"
71
                          | "BJ"
72
                          | "BM"
73
                          | "BT"
74
                          | "BO"
75
                          | "BA"
76
                          | "BW"
77
                          | "BV"
78
                          | "BR"
79
                          | "IO"
80
                          | "BN"
81
                          | "BG"
82
                          | "BF"
83
                          | "BI"
84
                          | "KH"
85
                          | "CM"
86
                          | "CA"
87
                          | "CV"
88
                          | "KY"
89
                          | "CF"
90
                          | "TD"
91
                          | "CL"
92
                          | "CN"
93
                          | "CX"
94
                          | "CC"
95
                          | "CO"
96
                          | "KM"
97
                          | "CG"
98
                          | "CD"
99
                          | "CK"
100
                          | "CR"
101
                          | "CI"
102
                          | "HR"
103
                          | "CU"
104
                          | "CW"
105
                          | "CY"
106
                          | "CZ"
107
                          | "DK"
108
                          | "DJ"
109
                          | "DM"
110
                          | "DO"
111
                          | "EC"
112
                          | "EG"
113
                          | "SV"
114
                          | "GQ"
115
                          | "ER"
116
                          | "EE"
117
                          | "ET"
118
                          | "FK"
119
                          | "FO"
120
                          | "FJ"
121
                          | "FI"
122
                          | "FR"
123
                          | "GF"
124
                          | "PF"
125
                          | "TF"
126
                          | "GA"
127
                          | "GM"
128
                          | "GE"
129
                          | "DE"
130
                          | "GH"
131
                          | "GI"
132
                          | "GR"
133
                          | "GL"
134
                          | "GD"
135
                          | "GP"
136
                          | "GU"
137
                          | "GT"
138
                          | "GG"
139
                          | "GN"
140
                          | "GW"
141
                          | "GY"
142
                          | "HT"
143
                          | "HM"
144
                          | "VA"
145
                          | "HN"
146
                          | "HK"
147
                          | "HU"
148
                          | "IS"
149
                          | "IN"
150
                          | "ID"
151
                          | "IR"
152
                          | "IQ"
153
                          | "IE"
154
                          | "IM"
155
                          | "IL"
156
                          | "IT"
157
                          | "JM"
158
                          | "JP"
159
                          | "JE"
160
                          | "JO"
161
                          | "KZ"
162
                          | "KE"
163
                          | "KI"
164
                          | "KR"
165
                          | "KW"
166
                          | "KG"
167
                          | "LA"
168
                          | "LV"
169
                          | "LB"
170
                          | "LS"
171
                          | "LR"
172
                          | "LY"
173
                          | "LI"
174
                          | "LT"
175
                          | "LU"
176
                          | "MO"
177
                          | "MK"
178
                          | "MG"
179
                          | "MW"
180
                          | "MY"
181
                          | "MV"
182
                          | "ML"
183
                          | "MT"
184
                          | "MH"
185
                          | "MQ"
186
                          | "MR"
187
                          | "MU"
188
                          | "YT"
189
                          | "MX"
190
                          | "FM"
191
                          | "MD"
192
                          | "MC"
193
                          | "MN"
194
                          | "ME"
195
                          | "MS"
196
                          | "MA"
197
                          | "MZ"
198
                          | "MM"
199
                          | "NA"
200
                          | "NR"
201
                          | "NP"
202
                          | "NL"
203
                          | "AN"
204
                          | "NC"
205
                          | "NZ"
206
                          | "NI"
207
                          | "NE"
208
                          | "NG"
209
                          | "NU"
210
                          | "NF"
211
                          | "MP"
212
                          | "NO"
213
                          | "OM"
214
                          | "PK"
215
                          | "PW"
216
                          | "PS"
217
                          | "PA"
218
                          | "PG"
219
                          | "PY"
220
                          | "PE"
221
                          | "PH"
222
                          | "PN"
223
                          | "PL"
224
                          | "PT"
225
                          | "PR"
226
                          | "QA"
227
                          | "RE"
228
                          | "RO"
229
                          | "RU"
230
                          | "RW"
231
                          | "BL"
232
                          | "SH"
233
                          | "KN"
234
                          | "LC"
235
                          | "MF"
236
                          | "PM"
237
                          | "VC"
238
                          | "WS"
239
                          | "SM"
240
                          | "ST"
241
                          | "SA"
242
                          | "SN"
243
                          | "SS"
244
                          | "RS"
245
                          | "SC"
246
                          | "SL"
247
                          | "SG"
248
                          | "SK"
249
                          | "SI"
250
                          | "SB"
251
                          | "SO"
252
                          | "ZA"
253
                          | "GS"
254
                          | "ES"
255
                          | "LK"
256
                          | "SD"
257
                          | "SR"
258
                          | "SJ"
259
                          | "SZ"
260
                          | "SE"
261
                          | "CH"
262
                          | "SY"
263
                          | "TW"
264
                          | "TJ"
265
                          | "TZ"
266
                          | "TH"
267
                          | "TL"
268
                          | "TG"
269
                          | "TK"
270
                          | "TO"
271
                          | "TT"
272
                          | "TN"
273
                          | "TR"
274
                          | "TM"
275
                          | "TC"
276
                          | "TV"
277
                          | "UG"
278
                          | "UA"
279
                          | "AE"
280
                          | "GB"
281
                          | "US"
282
                          | "UM"
283
                          | "UY"
284
                          | "UZ"
285
                          | "VU"
286
                          | "VE"
287
                          | "VN"
288
                          | "VG"
289
                          | "VI"
290
                          | "WF"
291
                          | "EH"
292
                          | "YE"
293
                          | "ZM"
294
                          | "ZW";
295
                      }
296
                    | { value?: string }[];
297
                }
298
              | {
299
                  interaction_type:
300
                    | "calendar-event"
301
                    | "call"
302
                    | "chat-thread"
303
                    | "email"
304
                    | "in-person-meeting"
305
                    | "meeting";
306
                  interacted_at: string;
307
                  owner_actor: {
308
                    id?: string;
309
                    type?: "workspace-member" | "api-token" | "system" | "app";
310
                  };
311
                }
312
              | {
313
                  line_1: string;
314
                  line_2: string;
315
                  line_3: string;
316
                  line_4: string;
317
                  locality: string;
318
                  region: string;
319
                  postcode: string;
320
                  country_code:
321
                    | "AF"
322
                    | "AX"
323
                    | "AL"
324
                    | "DZ"
325
                    | "AS"
326
                    | "AD"
327
                    | "AO"
328
                    | "AI"
329
                    | "AQ"
330
                    | "AG"
331
                    | "AR"
332
                    | "AM"
333
                    | "AW"
334
                    | "AU"
335
                    | "AT"
336
                    | "AZ"
337
                    | "BS"
338
                    | "BH"
339
                    | "BD"
340
                    | "BB"
341
                    | "BY"
342
                    | "BE"
343
                    | "BZ"
344
                    | "BJ"
345
                    | "BM"
346
                    | "BT"
347
                    | "BO"
348
                    | "BA"
349
                    | "BW"
350
                    | "BV"
351
                    | "BR"
352
                    | "IO"
353
                    | "BN"
354
                    | "BG"
355
                    | "BF"
356
                    | "BI"
357
                    | "KH"
358
                    | "CM"
359
                    | "CA"
360
                    | "CV"
361
                    | "KY"
362
                    | "CF"
363
                    | "TD"
364
                    | "CL"
365
                    | "CN"
366
                    | "CX"
367
                    | "CC"
368
                    | "CO"
369
                    | "KM"
370
                    | "CG"
371
                    | "CD"
372
                    | "CK"
373
                    | "CR"
374
                    | "CI"
375
                    | "HR"
376
                    | "CU"
377
                    | "CW"
378
                    | "CY"
379
                    | "CZ"
380
                    | "DK"
381
                    | "DJ"
382
                    | "DM"
383
                    | "DO"
384
                    | "EC"
385
                    | "EG"
386
                    | "SV"
387
                    | "GQ"
388
                    | "ER"
389
                    | "EE"
390
                    | "ET"
391
                    | "FK"
392
                    | "FO"
393
                    | "FJ"
394
                    | "FI"
395
                    | "FR"
396
                    | "GF"
397
                    | "PF"
398
                    | "TF"
399
                    | "GA"
400
                    | "GM"
401
                    | "GE"
402
                    | "DE"
403
                    | "GH"
404
                    | "GI"
405
                    | "GR"
406
                    | "GL"
407
                    | "GD"
408
                    | "GP"
409
                    | "GU"
410
                    | "GT"
411
                    | "GG"
412
                    | "GN"
413
                    | "GW"
414
                    | "GY"
415
                    | "HT"
416
                    | "HM"
417
                    | "VA"
418
                    | "HN"
419
                    | "HK"
420
                    | "HU"
421
                    | "IS"
422
                    | "IN"
423
                    | "ID"
424
                    | "IR"
425
                    | "IQ"
426
                    | "IE"
427
                    | "IM"
428
                    | "IL"
429
                    | "IT"
430
                    | "JM"
431
                    | "JP"
432
                    | "JE"
433
                    | "JO"
434
                    | "KZ"
435
                    | "KE"
436
                    | "KI"
437
                    | "KR"
438
                    | "KW"
439
                    | "KG"
440
                    | "LA"
441
                    | "LV"
442
                    | "LB"
443
                    | "LS"
444
                    | "LR"
445
                    | "LY"
446
                    | "LI"
447
                    | "LT"
448
                    | "LU"
449
                    | "MO"
450
                    | "MK"
451
                    | "MG"
452
                    | "MW"
453
                    | "MY"
454
                    | "MV"
455
                    | "ML"
456
                    | "MT"
457
                    | "MH"
458
                    | "MQ"
459
                    | "MR"
460
                    | "MU"
461
                    | "YT"
462
                    | "MX"
463
                    | "FM"
464
                    | "MD"
465
                    | "MC"
466
                    | "MN"
467
                    | "ME"
468
                    | "MS"
469
                    | "MA"
470
                    | "MZ"
471
                    | "MM"
472
                    | "NA"
473
                    | "NR"
474
                    | "NP"
475
                    | "NL"
476
                    | "AN"
477
                    | "NC"
478
                    | "NZ"
479
                    | "NI"
480
                    | "NE"
481
                    | "NG"
482
                    | "NU"
483
                    | "NF"
484
                    | "MP"
485
                    | "NO"
486
                    | "OM"
487
                    | "PK"
488
                    | "PW"
489
                    | "PS"
490
                    | "PA"
491
                    | "PG"
492
                    | "PY"
493
                    | "PE"
494
                    | "PH"
495
                    | "PN"
496
                    | "PL"
497
                    | "PT"
498
                    | "PR"
499
                    | "QA"
500
                    | "RE"
501
                    | "RO"
502
                    | "RU"
503
                    | "RW"
504
                    | "BL"
505
                    | "SH"
506
                    | "KN"
507
                    | "LC"
508
                    | "MF"
509
                    | "PM"
510
                    | "VC"
511
                    | "WS"
512
                    | "SM"
513
                    | "ST"
514
                    | "SA"
515
                    | "SN"
516
                    | "SS"
517
                    | "RS"
518
                    | "SC"
519
                    | "SL"
520
                    | "SG"
521
                    | "SK"
522
                    | "SI"
523
                    | "SB"
524
                    | "SO"
525
                    | "ZA"
526
                    | "GS"
527
                    | "ES"
528
                    | "LK"
529
                    | "SD"
530
                    | "SR"
531
                    | "SJ"
532
                    | "SZ"
533
                    | "SE"
534
                    | "CH"
535
                    | "SY"
536
                    | "TW"
537
                    | "TJ"
538
                    | "TZ"
539
                    | "TH"
540
                    | "TL"
541
                    | "TG"
542
                    | "TK"
543
                    | "TO"
544
                    | "TT"
545
                    | "TN"
546
                    | "TR"
547
                    | "TM"
548
                    | "TC"
549
                    | "TV"
550
                    | "UG"
551
                    | "UA"
552
                    | "AE"
553
                    | "GB"
554
                    | "US"
555
                    | "UM"
556
                    | "UY"
557
                    | "UZ"
558
                    | "VU"
559
                    | "VE"
560
                    | "VN"
561
                    | "VG"
562
                    | "VI"
563
                    | "WF"
564
                    | "EH"
565
                    | "YE"
566
                    | "ZM"
567
                    | "ZW";
568
                  latitude: string;
569
                  longitude: string;
570
                }
571
              | { value: number }
572
              | { first_name?: string; last_name?: string; full_name?: string }
573
              | {
574
                  original_phone_number: string;
575
                  country_code?:
576
                    | "AF"
577
                    | "AX"
578
                    | "AL"
579
                    | "DZ"
580
                    | "AS"
581
                    | "AD"
582
                    | "AO"
583
                    | "AI"
584
                    | "AQ"
585
                    | "AG"
586
                    | "AR"
587
                    | "AM"
588
                    | "AW"
589
                    | "AU"
590
                    | "AT"
591
                    | "AZ"
592
                    | "BS"
593
                    | "BH"
594
                    | "BD"
595
                    | "BB"
596
                    | "BY"
597
                    | "BE"
598
                    | "BZ"
599
                    | "BJ"
600
                    | "BM"
601
                    | "BT"
602
                    | "BO"
603
                    | "BA"
604
                    | "BW"
605
                    | "BV"
606
                    | "BR"
607
                    | "IO"
608
                    | "BN"
609
                    | "BG"
610
                    | "BF"
611
                    | "BI"
612
                    | "KH"
613
                    | "CM"
614
                    | "CA"
615
                    | "CV"
616
                    | "KY"
617
                    | "CF"
618
                    | "TD"
619
                    | "CL"
620
                    | "CN"
621
                    | "CX"
622
                    | "CC"
623
                    | "CO"
624
                    | "KM"
625
                    | "CG"
626
                    | "CD"
627
                    | "CK"
628
                    | "CR"
629
                    | "CI"
630
                    | "HR"
631
                    | "CU"
632
                    | "CW"
633
                    | "CY"
634
                    | "CZ"
635
                    | "DK"
636
                    | "DJ"
637
                    | "DM"
638
                    | "DO"
639
                    | "EC"
640
                    | "EG"
641
                    | "SV"
642
                    | "GQ"
643
                    | "ER"
644
                    | "EE"
645
                    | "ET"
646
                    | "FK"
647
                    | "FO"
648
                    | "FJ"
649
                    | "FI"
650
                    | "FR"
651
                    | "GF"
652
                    | "PF"
653
                    | "TF"
654
                    | "GA"
655
                    | "GM"
656
                    | "GE"
657
                    | "DE"
658
                    | "GH"
659
                    | "GI"
660
                    | "GR"
661
                    | "GL"
662
                    | "GD"
663
                    | "GP"
664
                    | "GU"
665
                    | "GT"
666
                    | "GG"
667
                    | "GN"
668
                    | "GW"
669
                    | "GY"
670
                    | "HT"
671
                    | "HM"
672
                    | "VA"
673
                    | "HN"
674
                    | "HK"
675
                    | "HU"
676
                    | "IS"
677
                    | "IN"
678
                    | "ID"
679
                    | "IR"
680
                    | "IQ"
681
                    | "IE"
682
                    | "IM"
683
                    | "IL"
684
                    | "IT"
685
                    | "JM"
686
                    | "JP"
687
                    | "JE"
688
                    | "JO"
689
                    | "KZ"
690
                    | "KE"
691
                    | "KI"
692
                    | "KR"
693
                    | "KW"
694
                    | "KG"
695
                    | "LA"
696
                    | "LV"
697
                    | "LB"
698
                    | "LS"
699
                    | "LR"
700
                    | "LY"
701
                    | "LI"
702
                    | "LT"
703
                    | "LU"
704
                    | "MO"
705
                    | "MK"
706
                    | "MG"
707
                    | "MW"
708
                    | "MY"
709
                    | "MV"
710
                    | "ML"
711
                    | "MT"
712
                    | "MH"
713
                    | "MQ"
714
                    | "MR"
715
                    | "MU"
716
                    | "YT"
717
                    | "MX"
718
                    | "FM"
719
                    | "MD"
720
                    | "MC"
721
                    | "MN"
722
                    | "ME"
723
                    | "MS"
724
                    | "MA"
725
                    | "MZ"
726
                    | "MM"
727
                    | "NA"
728
                    | "NR"
729
                    | "NP"
730
                    | "NL"
731
                    | "AN"
732
                    | "NC"
733
                    | "NZ"
734
                    | "NI"
735
                    | "NE"
736
                    | "NG"
737
                    | "NU"
738
                    | "NF"
739
                    | "MP"
740
                    | "NO"
741
                    | "OM"
742
                    | "PK"
743
                    | "PW"
744
                    | "PS"
745
                    | "PA"
746
                    | "PG"
747
                    | "PY"
748
                    | "PE"
749
                    | "PH"
750
                    | "PN"
751
                    | "PL"
752
                    | "PT"
753
                    | "PR"
754
                    | "QA"
755
                    | "RE"
756
                    | "RO"
757
                    | "RU"
758
                    | "RW"
759
                    | "BL"
760
                    | "SH"
761
                    | "KN"
762
                    | "LC"
763
                    | "MF"
764
                    | "PM"
765
                    | "VC"
766
                    | "WS"
767
                    | "SM"
768
                    | "ST"
769
                    | "SA"
770
                    | "SN"
771
                    | "SS"
772
                    | "RS"
773
                    | "SC"
774
                    | "SL"
775
                    | "SG"
776
                    | "SK"
777
                    | "SI"
778
                    | "SB"
779
                    | "SO"
780
                    | "ZA"
781
                    | "GS"
782
                    | "ES"
783
                    | "LK"
784
                    | "SD"
785
                    | "SR"
786
                    | "SJ"
787
                    | "SZ"
788
                    | "SE"
789
                    | "CH"
790
                    | "SY"
791
                    | "TW"
792
                    | "TJ"
793
                    | "TZ"
794
                    | "TH"
795
                    | "TL"
796
                    | "TG"
797
                    | "TK"
798
                    | "TO"
799
                    | "TT"
800
                    | "TN"
801
                    | "TR"
802
                    | "TM"
803
                    | "TC"
804
                    | "TV"
805
                    | "UG"
806
                    | "UA"
807
                    | "AE"
808
                    | "GB"
809
                    | "US"
810
                    | "UM"
811
                    | "UY"
812
                    | "UZ"
813
                    | "VU"
814
                    | "VE"
815
                    | "VN"
816
                    | "VG"
817
                    | "VI"
818
                    | "WF"
819
                    | "EH"
820
                    | "YE"
821
                    | "ZM"
822
                    | "ZW";
823
                }
824
              | { status: string }
825
              | { value: number }
826
              | { option: string }
827
              | { value: string }
828
              | { value: string }[];
829
          };
830
      config?: {
831
        currency?: {
832
          default_currency_code:
833
            | "AUD"
834
            | "BRL"
835
            | "BEL"
836
            | "CAD"
837
            | "CNY"
838
            | "COP"
839
            | "CZK"
840
            | "DKK"
841
            | "EUR"
842
            | "HKD"
843
            | "ISK"
844
            | "INR"
845
            | "ILS"
846
            | "JPY"
847
            | "KRW"
848
            | "MYR"
849
            | "MXN"
850
            | "NTD"
851
            | "NZD"
852
            | "NGN"
853
            | "NOK"
854
            | "PEN"
855
            | "PHP"
856
            | "PLN"
857
            | "GBP"
858
            | "SGD"
859
            | "ZAR"
860
            | "SEK"
861
            | "CHF"
862
            | "AED"
863
            | "USD";
864
          display_type: "symbol" | "code" | "name" | "narrowSymbol";
865
        };
866
        record_reference?: { allowed_objects: string[] };
867
      };
868
      is_archived?: false | true;
869
    };
870
  },
871
) {
872
  const url = new URL(
873
    `https://api.attio.com/v2/${target}/${identifier}/attributes/${attribute}`,
874
  );
875

876
  const response = await fetch(url, {
877
    method: "PATCH",
878
    headers: {
879
      "Content-Type": "application/json",
880
      Authorization: "Bearer " + auth.token,
881
    },
882
    body: JSON.stringify(body),
883
  });
884
  if (!response.ok) {
885
    const text = await response.text();
886
    throw new Error(`${response.status} ${text}`);
887
  }
888
  return await response.json();
889
}
890