loops-so 0.3.0

Unofficial Rust SDK for the Loops.so email platform
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
openapi: 3.1.0
info:
  title: Loops OpenAPI Spec
  description: This is the OpenAPI Spec for the [Loops API](https://loops.so/docs/api).
  version: 1.22.6
servers:
  - url: https://app.loops.so/api
tags:
  - name: API key
  - name: Audience segments
    description: View audience segments
  - name: Campaigns
    description: Create and manage email campaigns
  - name: Campaign groups
    description: Organize campaigns into groups
  - name: Configuration
    description: View configuration settings
  - name: Contacts
    description: Manage contacts in your audience
  - name: Contact properties
    description: Manage contact properties
  - name: Components
    description: View email components
  - name: Email messages
    description: Manage email message content for campaigns
  - name: Events
    description: Trigger workflows with events
  - name: Event patterns
    description: View workflow event patterns
  - name: Mailing lists
    description: View mailing lists
  - name: Themes
    description: View email themes
  - name: Transactional emails
    description: Create, manage, and send transactional emails
  - name: Transactional groups
    description: Organize transactional emails into groups
  - name: Uploads
    description: Upload image assets
  - name: Workflows
    description: View and mutate workflow graphs
  - name: Workflow groups
    description: Organize workflows into groups
  - name: Workflow nodes
    description: View and mutate workflow nodes
  - name: Webhooks
    description: Events Loops sends to your configured webhook endpoint when certain
      events happen in your account. Configure an endpoint in Settings →
      Webhooks. Each account supports one webhook endpoint. Events are signed
      with `webhook-id`, `webhook-timestamp`, and `webhook-signature` headers
      and delivered at a maximum rate of 10 per second. See
      https://loops.so/docs/webhooks for setup, verification, and payload
      details.
paths:
  /v1/api-key:
    get:
      operationId: testApiKey
      tags:
        - API key
      summary: API key
      description: Test your API key and get team context.
      x-mint:
        href: /api-reference/api-key
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    examples:
                      - true
                  teamName:
                    type: string
                    description: The name of the team the API key belongs to.
                    examples:
                      - Company name
                required:
                  - success
                  - teamName
        "401":
          description: Invalid API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    examples:
                      - false
                  message:
                    type: string
                    examples:
                      - Invalid API key
                  error:
                    type: string
                    deprecated: true
                    examples:
                      - Invalid API key
      security:
        - apiKey: []
  /v1/audience-segments/{audienceSegmentId}:
    parameters:
      - name: audienceSegmentId
        in: path
        required: true
        description: The ID of the audience segment.
        schema:
          type: string
          examples:
            - cls6e8g0i2k4m6o8q0s2u4w6
    get:
      operationId: getAudienceSegment
      tags:
        - Audience segments
      summary: Get an audience segment
      description: Retrieve a single audience segment by ID.
      x-mint:
        href: /api-reference/get-audience-segment
        metadata:
          sidebarTitle: Get a segment
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AudienceSegmentResponse"
        "400":
          description: Invalid `audienceSegmentId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AudienceSegmentFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Audience segment not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AudienceSegmentFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/audience-segments:
    get:
      operationId: listAudienceSegments
      tags:
        - Audience segments
      summary: List audience segments
      description: Retrieve a paginated list of audience segments, most recently
        created first.
      x-mint:
        href: /api-reference/list-audience-segments
        metadata:
          sidebarTitle: List segments
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAudienceSegmentsResponse"
        "400":
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AudienceSegmentFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: createAudienceSegment
      tags:
        - Audience segments
      summary: Create an audience segment
      description: Create a new audience segment.
      x-mint:
        href: /api-reference/create-audience-segment
        metadata:
          sidebarTitle: Create a segment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateAudienceSegmentRequest"
      responses:
        "200":
          description: Audience segment created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AudienceSegmentResponse"
        "400":
          description: Invalid request body, a name already used by another segment, or a
            filter with too many conditions.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AudienceSegmentFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: The filter references a campaign, workflow or workflow email that
            does not exist.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AudienceSegmentFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/campaigns:
    get:
      operationId: listCampaigns
      tags:
        - Campaigns
      summary: List campaigns
      description: Retrieve a paginated list of campaigns.
      x-mint:
        href: /api-reference/list-campaigns
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListCampaignsResponse"
        "400":
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: createCampaign
      tags:
        - Campaigns
      summary: Create a campaign
      description: Create a new draft campaign. An empty email message is created
        automatically and its `emailMessageId` is returned. Use the
        `/email-messages/{emailMessageId}` endpoint to set subject, sender,
        preview text, and LMX content. The audience (mailing list, segment, or
        filter), group, and scheduling can be set on create or later via update.
      x-mint:
        href: /api-reference/create-campaign
        metadata:
          description: Create a draft marketing campaign and its associated email message.
        content: >-
          This endpoint creates a draft campaign and an empty email message in
          one step. Use the returned `emailMessageId` with [Update an email
          message](/api-reference/update-email-message) to set subject, sender,
          preview text, and LMX content.


          The audience (mailing list, segment, or filter), group, and scheduling
          can be set on create or later via [Update a
          campaign](/api-reference/update-campaign).


          <Tip>To send a test preview of a campaign, use the [Preview email
          message](/api-reference/preview-email-message) endpoint.</Tip>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateCampaignRequest"
      responses:
        "201":
          description: Campaign created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateCampaignResponse"
        "400":
          description: Invalid request body, campaign group not found, or no sending
            domain configured.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Referenced mailing list or audience segment not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/campaigns/{campaignId}:
    parameters:
      - name: campaignId
        in: path
        required: true
        description: The ID of the campaign.
        schema:
          type: string
          examples:
            - clc4m6n8p0q2r4s6t8u0v2x4
    get:
      operationId: getCampaign
      tags:
        - Campaigns
      summary: Get a campaign
      description: Retrieve a single campaign by ID.
      x-mint:
        href: /api-reference/get-campaign
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignResponse"
        "400":
          description: Invalid `campaignId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Campaign not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: updateCampaign
      tags:
        - Campaigns
      summary: Update a campaign
      description: Update a draft campaign's name, group, audience (mailing list,
        segment, or filter), or scheduling. At least one field must be provided.
        Once a campaign has been sent, only its `name` and `campaignGroupId` can
        be updated.
      x-mint:
        href: /api-reference/update-campaign
        metadata:
          description: Update a draft campaign's name, group, audience (mailing list,
            segment, or filter), or scheduling.
        content: <Info>At least one field must be provided. Draft campaigns support
          every field below. Once a campaign has been sent, only `name` and
          `campaignGroupId` can be updated.</Info>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateCampaignRequest"
      responses:
        "200":
          description: Campaign updated.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignResponse"
        "400":
          description: Invalid request body or campaign group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Campaign, mailing list, or audience segment not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: Campaign has been sent and the request updates a field other than
            `name` or `campaignGroupId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
      security:
        - apiKey: []
  /v1/campaigns/{campaignId}/metrics:
    parameters:
      - name: campaignId
        in: path
        required: true
        description: The ID of the campaign.
        schema:
          type: string
          examples:
            - clc4m6n8p0q2r4s6t8u0v2x4
    get:
      operationId: getCampaignMetrics
      tags:
        - Campaigns
      summary: Get campaign metrics
      description: Retrieve all-time email engagement metrics for a campaign.
      x-mint:
        href: /api-reference/get-campaign-metrics
        metadata:
          description: Retrieve all-time email engagement metrics for a campaign.
          sidebarTitle: Get metrics
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMetricsResponse"
        "400":
          description: Invalid `campaignId`, the campaign has not been sent yet, or the
            campaign has no email message.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Campaign not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CampaignFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/campaign-groups:
    get:
      operationId: listCampaignGroups
      tags:
        - Campaign groups
      summary: List campaign groups
      description: Retrieve a paginated list of campaign groups, most recently created
        first.
      x-mint:
        href: /api-reference/list-campaign-groups
        metadata:
          sidebarTitle: List groups
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListGroupsResponse"
        "400":
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: createCampaignGroup
      tags:
        - Campaign groups
      summary: Create a campaign group
      description: Create a new campaign group.
      x-mint:
        href: /api-reference/create-campaign-group
        metadata:
          sidebarTitle: Create a group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateGroupRequest"
      responses:
        "200":
          description: Campaign group created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid request body or reserved group name.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/campaign-groups/{campaignGroupId}:
    parameters:
      - name: campaignGroupId
        in: path
        required: true
        description: The ID of the campaign group.
        schema:
          type: string
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
    get:
      operationId: getCampaignGroup
      tags:
        - Campaign groups
      summary: Get a campaign group
      description: Retrieve a single campaign group by ID.
      x-mint:
        href: /api-reference/get-campaign-group
        metadata:
          sidebarTitle: Get a group
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid `campaignGroupId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Campaign group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: updateCampaignGroup
      tags:
        - Campaign groups
      summary: Update a campaign group
      description: Update a campaign group's name or description. At least one field
        must be provided. The reserved "Unsorted" group cannot be edited.
      x-mint:
        href: /api-reference/update-campaign-group
        content: <Info>At least one field must be provided. The reserved "Unsorted"
          group cannot be edited.</Info>
        metadata:
          description: Update a campaign group's name or description.
          sidebarTitle: Update a group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateGroupRequest"
      responses:
        "200":
          description: Campaign group updated.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid request body, reserved group name, or the Unsorted group
            cannot be edited.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Campaign group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/dedicated-sending-ips:
    get:
      operationId: listDedicatedSendingIps
      tags:
        - Configuration
      summary: List dedicated sending IP addresses
      description: >-
        Retrieve a list of Loops' dedicated sending IP addresses.


        This endpoint is provided for the rare instances where you may need to
        whitelist our sending IPs. Please note that this list is subject to
        change and will not include shared IPs used for sending mail.


        Unless you are sure you need this and are comfortable watching for
        changes, we strongly recommend you _do not_ whitelist these IPs.
      x-mint:
        href: /api-reference/dedicated-sending-ips
        metadata:
          description: Retrieve a list of Loops' dedicated sending IP addresses.
          sidebarTitle: List sending IPs
        content: <Warning>This endpoint is provided for the rare instances where you may
          need to whitelist our sending IPs. Please note that this list is
          subject to change and will not include shared IPs used for sending
          mail. Unless you are sure you need this and are comfortable watching
          for changes, we strongly recommend you _do not_ whitelist these
          IPs.</Warning>
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                type: array
                description: Returns an array of IP address strings.
                items:
                  type: string
                  description: IP address
                  examples:
                    - 52.21.45.123
                example:
                  - 52.21.45.123
                  - 52.21.45.124
                  - 52.21.45.125
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/contacts/create:
    post:
      operationId: createContact
      tags:
        - Contacts
      summary: Create a contact
      description: Add a contact to your audience.
      x-mint:
        href: /api-reference/create-contact
        content: <Tip>If you want to "update or create" contacts, consider using the
          [Update a contact](https://loops.so/docs/api-reference/update-contact)
          endpoint instead.</Tip>
      requestBody:
        description: You can add custom contact properties as keys in this request (of
          type `string`, `number`, `boolean` or `date`. [See available date
          formats](https://loops.so/docs/contacts/properties#dates)). Make sure
          to create the properties in Loops before using them in API calls.
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContactRequest"
        required: true
      responses:
        "200":
          description: Successful create.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactSuccessResponse"
        "400":
          description: Bad request (e.g. invalid email address).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: Email or `userId` already exists.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
      security:
        - apiKey: []
  /v1/contacts/update:
    put:
      operationId: updateContact
      tags:
        - Contacts
      summary: Update a contact
      description: >-
        Update a contact by `email` or `userId`. You must provide one of these
        parameters.


        If you want to update a contact's email address, the contact will first
        need a `userId` value. You can then make a request containing the
        `userId` field along with an updated email address.


        This endpoint will create a contact if a matching contact does not
        already exist in your audience.


        Provide either `email` or `userId` to identify the contact you want to
        update. If both are provided, the system will look for a contact with
        either a matching `email` or `userId` value. If a contact is found for
        one of the values (e.g. `email`), the other value (e.g. `userId`) will
        be updated. If a contact is not found, a new contact will be created
        using both `email` and `userId` values.
      x-mint:
        href: /api-reference/update-contact
        content: >-
          Update a contact by `email` or `userId`. You must provide one of these
          parameters.


          If you want to update a contact's email address, the contact will
          first need a `userId` value. You can then make a request containing
          the `userId` field along with an updated email address.


          This endpoint will create a contact if a matching contact does not
          already exist in your audience.


          <Note>Provide either `email` or `userId` to identify the contact you
          want to update. If both are provided, the system will look for a
          contact with either a matching `email` or `userId` value. If a contact
          is found for one of the values (e.g. `email`), the other value (e.g.
          `userId`) will be updated. If a contact is not found, a new contact
          will be created using both `email` and `userId` values.</Note>
        metadata:
          sidebarTitle: Update a contact
          description: Update or create a contact.
      requestBody:
        description: You can add custom contact properties as keys in this request (of
          type `string`, `number`, `boolean` or `date`. [See available date
          formats](https://loops.so/docs/contacts/properties#dates)). Make sure
          to create the properties in Loops before using them in API calls.
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContactUpdateRequest"
        required: true
      responses:
        "200":
          description: Successful update.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactSuccessResponse"
        "400":
          description: Bad request (e.g. `email` or `userId` are missing).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/contacts/find:
    get:
      operationId: findContact
      tags:
        - Contacts
      summary: Find a contact
      description: Search for a contact by `email` or `userId`. Only one parameter is
        allowed.
      x-mint:
        href: /api-reference/find-contact
        content: Search for a contact by `email` or `userId`. Only one parameter is
          allowed.
        metadata:
          description: Find a contact by email address or user ID.
      parameters:
        - name: email
          in: query
          required: false
          description: Email address (URI-encoded)
          schema:
            type: string
        - name: userId
          in: query
          required: false
          schema:
            type: string
      responses:
        "200":
          description: List of contacts (or an empty array if no contact was found).
            Contact objects will include any custom properties.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Contact"
        "400":
          description: Bad request (e.g. invalid email address).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/contacts/delete:
    post:
      operationId: deleteContact
      tags:
        - Contacts
      summary: Delete a contact
      description: Delete a contact by `email` or `userId`.
      x-mint:
        href: /api-reference/delete-contact
        content: Delete a contact by `email` or `userId`.
        metadata:
          sidebarTitle: Delete a contact
          description: Delete a contact by email address or user ID.
      requestBody:
        description: Include only one of `email` or `userId`.
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContactDeleteRequest"
        required: true
      responses:
        "200":
          description: Successful delete.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactDeleteResponse"
        "400":
          description: Bad request (e.g. `email` and `userId` are both provided).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "404":
          description: Contact not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/contacts/suppression:
    get:
      operationId: getContactSuppression
      tags:
        - Contacts
      summary: Get suppression status for a contact
      description: Retrieve suppression status and removal quota for a contact by
        `email` or `userId`. Include only one query parameter.
      x-mint:
        href: /api-reference/check-contact-suppression
        metadata:
          title: Check contact suppression status
          sidebarTitle: Check suppression
          description: Check if a contact is suppressed by email address or user ID.
      parameters:
        - name: email
          in: query
          required: false
          description: Email address (URI-encoded)
          schema:
            type: string
        - name: userId
          in: query
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactSuppressionStatusResponse"
        "400":
          description: Bad request (e.g. invalid email address).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "404":
          description: Contact not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    delete:
      operationId: removeContactSuppression
      tags:
        - Contacts
      summary: Remove a contact from suppression list
      description: Remove a suppressed contact from the suppression list by `email` or
        `userId`. Include only one query parameter.
      x-mint:
        href: /api-reference/remove-contact-suppression
        metadata:
          title: Remove contact from suppression
          sidebarTitle: Remove suppression
          description: Remove suppression for a contact by email address or user ID.
      parameters:
        - name: email
          in: query
          required: false
          description: Email address (URI-encoded)
          schema:
            type: string
        - name: userId
          in: query
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Successful removal.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactSuppressionRemoveResponse"
        "400":
          description: Bad request (e.g. contact is not suppressed).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "404":
          description: Contact not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/contacts/properties:
    post:
      operationId: createContactProperty
      tags:
        - Contact properties
      summary: Create a contact property
      description: Create a custom contact property.
      x-mint:
        href: /api-reference/create-contact-property
        metadata:
          sidebarTitle: Create property
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ContactPropertyCreateRequest"
        required: true
      responses:
        "200":
          description: Successful create.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactPropertySuccessResponse"
        "400":
          description: Bad request (e.g. invalid type).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ContactPropertyFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    get:
      operationId: listContactProperties
      tags:
        - Contact properties
      summary: List contact properties
      description: Retrieve a list of your account's contact properties.<br>Use the
        `list` parameter to query "all" or "custom" properties.
      x-mint:
        href: /api-reference/list-contact-properties
        metadata:
          sidebarTitle: List properties
          description: Retrieve a list of your account's contact properties.
      parameters:
        - name: list
          in: query
          required: false
          description: "`all` (default) or `custom` (only custom contact properties)"
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ContactProperty"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/components/{componentId}:
    parameters:
      - name: componentId
        in: path
        required: true
        description: The ID of the component.
        schema:
          type: string
          examples:
            - clp2o4i6u8y0t5r3e1w7q9s1
    get:
      operationId: getComponent
      tags:
        - Components
      summary: Get a component
      description: Retrieve a single component by ID.
      x-mint:
        href: /api-reference/get-component
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentResponse"
        "400":
          description: Invalid `componentId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Component not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: updateComponent
      tags:
        - Components
      summary: Update a component
      description: Update a component's name and/or body. When the `lmx` body changes,
        the update cascades to every email using this component, and
        `affectedEmailCount` reports how many were affected. A change that would
        introduce a dynamic variable an email using the component cannot use is
        rejected.
      x-mint:
        href: /api-reference/update-component
        content: When the `lmx` body changes, the update cascades to every email using
          this component, and `affectedEmailCount` reports how many were
          affected. A change that would introduce a dynamic variable an email
          using the component cannot use is rejected.
        metadata:
          description: Update a component's name and/or LMX body. Body changes cascade to
            every email using the component.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateComponentBody"
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateComponentResponse"
        "400":
          description: Invalid `componentId` or request body.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Component not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "413":
          description: LMX body exceeds the size limit.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
        "422":
          description: Invalid LMX, or a body change that would break emails using the
            component.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentValidationFailureResponse"
      security:
        - apiKey: []
  /v1/components:
    get:
      operationId: listComponents
      tags:
        - Components
      summary: List components
      description: Retrieve a paginated list of email components.
      x-mint:
        href: /api-reference/list-components
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListComponentsResponse"
        "400":
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: createComponent
      tags:
        - Components
      summary: Create a component
      description: Create a new email component from an LMX body.
      x-mint:
        href: /api-reference/create-component
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateComponentBody"
      responses:
        "201":
          description: Component created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentResponse"
        "400":
          description: Invalid request body.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
        "413":
          description: LMX body exceeds the size limit.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
        "422":
          description: Invalid LMX.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ComponentFailureResponse"
      security:
        - apiKey: []
  /v1/email-messages/{emailMessageId}:
    parameters:
      - name: emailMessageId
        in: path
        required: true
        description: The ID of the email message.
        schema:
          type: string
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
    get:
      operationId: getEmailMessage
      tags:
        - Email messages
      summary: Get an email message
      description: Retrieve an email message, including its compiled LMX content.
      x-mint:
        href: /api-reference/get-email-message
        metadata:
          sidebarTitle: Get an email
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageResponse"
        "400":
          description: Invalid `emailMessageId` or no sending domain configured.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Email message not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: Email message uses MJML format or content cannot be parsed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
      security:
        - apiKey: []
    post:
      operationId: updateEmailMessage
      tags:
        - Email messages
      summary: Update an email message
      description: Update fields on an email message (subject, preview text, sender,
        LMX content). The campaign must be in draft status. Supply
        `expectedRevisionId` matching the current `contentRevisionId` — the
        server rejects mismatched revisions with 409.
      x-mint:
        href: /api-reference/update-email-message
        metadata:
          description: Update an email message's subject, preview text, sender, or LMX
            content.
          sidebarTitle: Update an email
        content: >-
          Supply `expectedRevisionId` matching the current `contentRevisionId`.


          <Info>The campaign or transactional email that owns this email message
          must be in `Draft` status.</Info>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateEmailMessageRequest"
      responses:
        "200":
          description: Email message updated.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageResponse"
        "400":
          description: Invalid request body.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Email message not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: Campaign is not in draft status, `contentRevisionId` is stale,
            content cannot be parsed, or email message uses MJML format.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "413":
          description: LMX payload exceeds the 100KB limit.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "422":
          description: LMX failed to compile.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
      security:
        - apiKey: []
  /v1/email-messages/{emailMessageId}/preview:
    parameters:
      - name: emailMessageId
        in: path
        required: true
        description: The ID of the email message.
        schema:
          type: string
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
    post:
      operationId: previewEmailMessage
      tags:
        - Email messages
      summary: Send a preview of an email message
      description: Send a test preview of an email message to one or more addresses.
        The accepted variable fields depend on the parent's type - campaign
        previews accept `contactProperties`, workflow previews accept
        `contactProperties` and `eventProperties`, and transactional previews
        accept `dataVariables`. Supplying a field the parent cannot reference is
        rejected with 400.
      x-mint:
        href: /api-reference/preview-email-message
        content: >-
          Send a test email message to one or more addresses. Accepted variable
          fields depend on the parent's type:


          - **Campaign** accepts `contactProperties`.

          - **Workflow** accepts `contactProperties` and `eventProperties`.

          - **Transactional** accepts `dataVariables`.


          Supplying a field the parent cannot reference results in a `400 Bad
          Request` error.


          Each team can send up to 100 preview emails per day.
        metadata:
          description: Send a test preview of an email message to one or more addresses.
          sidebarTitle: Preview email
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EmailMessagePreviewRequest"
      responses:
        "200":
          description: Preview scheduled.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessagePreviewResponse"
        "400":
          description: Invalid request body, or a variable field the parent cannot
            reference.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Email message not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "429":
          description: The daily preview limit was reached.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
      security:
        - apiKey: []
  /v1/email-messages/{emailMessageId}/guardian:
    parameters:
      - name: emailMessageId
        in: path
        required: true
        description: The ID of the email message.
        schema:
          type: string
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
    get:
      operationId: getEmailMessageGuardian
      tags:
        - Email messages
      summary: Run Guardian checks on an email message
      description: Validate an email message's content against Guardian rules and
        return any errors and warnings. Errors must be resolved before the email
        can be published, warnings are advisory.
      x-mint:
        href: /api-reference/run-guardian-checks
        content: >-
          Run the same [Guardian](/creating-emails/guardian) checks that run in
          the Loops editor on a saved email message. Use this to validate
          campaign, workflow, and transactional email content before publishing
          or sending.


          Checks depend on the email message's parent type:


          - **Campaign** validates contact properties and rendered links and
          buttons.

          - **Workflow** validates contact properties, event properties from the
          workflow's event trigger, and rendered links and buttons.

          - **Transactional** validates data variables and rendered links and
          buttons.

          - **System transactional** validates required data variables and
          rendered links and buttons.


          <Info>This will not work on MJML email messages, as they are not
          supported in the API.</Info>
        metadata:
          description: Run Guardian content validation on an email message and return
            errors and warnings before you publish or send.
          sidebarTitle: Guardian checks
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageGuardianResponse"
        "400":
          description: Invalid `emailMessageId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Email message not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: Email message uses MJML format.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMessageFailureResponse"
      security:
        - apiKey: []
  /v1/events/send:
    post:
      operationId: sendEvent
      tags:
        - Events
      summary: Send an event
      description: Send events to trigger workflows.
      x-mint:
        href: /api-reference/send-event
        content: >-
          <Note>Provide either an `email` or `userId` value or both to identify
          the contact. If both are provided, the system will look for a contact
          with either a matching `email` or `userId` value. If a contact is
          found for one of the values (e.g. `email`), the other value (e.g.
          `userId`) will be updated. If a contact is not found, a new contact
          will be created using both `email` and `userId` values.</Note>


          You can update the contact in this request by adding contact
          properties in the root of the request body. See `favoriteColor` and
          `planName` in the example.
      requestBody:
        description: Provide either `email` or `userId` to identify the contact ([read
          more](https://loops.so/docs/api-reference/send-event#body)).<br>Event
          properties will be available in emails sent by this event. Values of
          properties can be of type `string`, `number`, `boolean` or `date`
          ([see allowed date
          formats](https://loops.so/docs/events/properties#important-information-about-event-properties)).<br>Make
          sure to create the properties in Loops before using them in API
          calls.<br>You can add update the contact by adding contact properties
          as keys in this request (of type `string`, `number`, `boolean` or
          `date` ([see available date
          formats](https://loops.so/docs/contacts/properties#dates))).
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EventRequest"
        required: true
      parameters:
        - in: header
          name: Idempotency-Key
          description: >-
            Include a unique ID for this request (maximum 100 characters) to
            avoid duplicate emails.


            The value should be a string of up to 100 characters and should be
            unique for each request. We recommend using V4 UUIDs or some other
            method with enough guaranteed entropy to avoid collisions during a
            24 hour window.


            This endpoint will return a `409 Conflict` response if the
            idempotency key has been used in the previous 24 hours.
          schema:
            type: string
            maxLength: 100
      responses:
        "200":
          description: Successful send.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventSuccessResponse"
        "400":
          description: Bad request (e.g. `eventName` is missing).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: Idempotency key has been used.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/IdempotencyKeyFailureResponse"
      security:
        - apiKey: []
  /v1/event-patterns:
    get:
      tags:
        - Event patterns
      summary: List event patterns
      operationId: listEventPatterns
      description: Retrieve a paginated list of event patterns available to workflow
        event trigger nodes.
      x-mint:
        href: /api-reference/list-event-patterns
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListEventPatternsResponse"
        "400":
          description: Invalid `perPage` or `cursor` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventPatternFailureResponse"
        "401":
          description: Invalid API key.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/event-patterns/by-name/{eventName}:
    parameters:
      - name: eventName
        in: path
        required: true
        description: The exact event name. Event names are case-sensitive and should be
          URL-encoded if they contain special characters.
        schema:
          type: string
    get:
      tags:
        - Event patterns
      summary: Get an event pattern by name
      operationId: getEventPatternByName
      description: Retrieve event pattern details by event name for a workflow event
        trigger. Event names are case-sensitive, so `PaymentReceived` and
        `paymentReceived` are different events.
      x-mint:
        href: /api-reference/get-event-pattern-by-name
        metadata:
          sidebarTitle: Get by name
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventPattern"
        "400":
          description: Invalid `eventName`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventPatternFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Event pattern not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventPatternFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/event-patterns/{eventPatternId}:
    parameters:
      - name: eventPatternId
        in: path
        required: true
        description: The ID of the event pattern.
        schema:
          type: string
    get:
      tags:
        - Event patterns
      summary: Get an event pattern by ID
      operationId: getEventPattern
      description: Retrieve event pattern details for a workflow event trigger.
      x-mint:
        href: /api-reference/get-event-pattern
        metadata:
          sidebarTitle: Get by ID
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventPattern"
        "400":
          description: Invalid `eventPatternId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventPatternFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Event pattern not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventPatternFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/lists:
    get:
      operationId: listMailingLists
      tags:
        - Mailing lists
      summary: List mailing lists
      description: Retrieve a list of your account's mailing lists.
      x-mint:
        href: /api-reference/list-mailing-lists
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/MailingList"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/themes/{themeId}:
    parameters:
      - name: themeId
        in: path
        required: true
        description: The ID of the theme.
        schema:
          type: string
          examples:
            - clt3u5v7w9x1y3z5a7b9c1d3
    get:
      operationId: getTheme
      tags:
        - Themes
      summary: Get a theme
      description: Retrieve a single theme by ID.
      x-mint:
        href: /api-reference/get-theme
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThemeResponse"
        "400":
          description: Invalid `themeId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThemeFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Theme not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThemeFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: updateTheme
      tags:
        - Themes
      summary: Update a theme
      description: "Update a theme's name and/or styles. When `styles` change, the
        update cascades to every email using this theme, and
        `affectedEmailCount` in the response reports how many emails were
        affected. Manual style edits made on individual emails are preserved:
        the cascade only changes properties an email has not overridden. A
        per-email override is removed only when it becomes identical to the
        theme's new value, after which that email follows the theme for that
        property."
      x-mint:
        href: /api-reference/update-theme
        content: >-
          When `styles` change, the update cascades to every email using this
          theme, and `affectedEmailCount` in the response reports how many
          emails were affected.


          Manual style edits made on individual emails are preserved: the
          cascade only changes properties an email has not overridden. A
          per-email override is removed only when it becomes identical to the
          theme's new value, after which that email follows the theme for that
          property.
        metadata:
          description: Update a theme's name and/or styles. Style changes cascade to every
            email using the theme.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateThemeBody"
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateThemeResponse"
        "400":
          description: Invalid `themeId` or request body.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThemeFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Theme not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThemeFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/themes:
    get:
      operationId: listThemes
      tags:
        - Themes
      summary: List themes
      description: Retrieve a paginated list of email themes, most recently created first.
      x-mint:
        href: /api-reference/list-themes
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListThemesResponse"
        "400":
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThemeFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: createTheme
      tags:
        - Themes
      summary: Create a theme
      description: Create a new email theme for use across Loops emails.
      x-mint:
        href: /api-reference/create-theme
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateThemeBody"
      responses:
        "201":
          description: Theme created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThemeResponse"
        "400":
          description: Invalid request body.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThemeFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/transactional:
    post:
      operationId: sendTransactionalEmail
      tags:
        - Transactional emails
      summary: Send a transactional email
      description: >-
        Send a transactional email to a contact.<br>Please [email
        us](mailto:help@loops.so) to enable attachments on your account before
        using them with the API.


        To set dynamic Subject, From, Reply to, CC, BCC email header fields, add
        data variables to those fields in the editor, then include data for each
        variable in the API request. Read our transactional email guide for more
        details.
      x-mint:
        metadata:
          description: Send a transactional email.
          sidebarTitle: Send transactional
        href: /api-reference/send-transactional-email
        content: >-
          Send a transactional email, including optional data variables, to a
          single recipient.


          To set dynamic Subject, From, Reply to, CC, BCC email header fields,
          add data variables to those fields in the editor, then include data
          for each variable in the API request. Read our [transactional email
          guide](/transactional) for more details.


          To send a test preview of a transactional email, use the [Preview
          email message](/api-reference/preview-email-message) endpoint.


          <Note>Please [email us](mailto:help@loops.so) to enable attachments on
          your account before using them with the API.</Note>
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TransactionalRequest"
        required: true
      parameters:
        - in: header
          name: Idempotency-Key
          description: >-
            Include a unique ID for this request (maximum 100 characters) to
            avoid duplicate emails.


            The value should be a string of up to 100 characters and should be
            unique for each request. We recommend using V4 UUIDs or some other
            method with enough guaranteed entropy to avoid collisions during a
            24 hour window.


            This endpoint will return a `409 Conflict` response if the
            idempotency key has been used in the previous 24 hours.
          schema:
            type: string
            maxLength: 100
      responses:
        "200":
          description: Successful send.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalSuccessResponse"
        "400":
          description: Bad request (e.g. transactional email is not published).
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: "#/components/schemas/TransactionalSendFailureResponse"
                  - $ref: "#/components/schemas/TransactionalFailure2Response"
                  - $ref: "#/components/schemas/TransactionalFailure3Response"
                  - $ref: "#/components/schemas/TransactionalFailure4Response"
                  - $ref: "#/components/schemas/TransactionalFailure5Response"
        "404":
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailure3Response"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: Idempotency key has been used.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/IdempotencyKeyFailureResponse"
      security:
        - apiKey: []
    get:
      operationId: listPublishedTransactionalEmails
      deprecated: true
      tags:
        - Transactional emails
      summary: List transactional emails (legacy)
      description: Get a list of published transactional emails.
      x-mint:
        href: /api-reference/list-transactional-emails-v1
        metadata:
          sidebarTitle: List transactionals (legacy)
        content: <Warning>This endpoint is deprecated. Use [List transactional
          emails](/api-reference/list-transactional-emails) instead.</Warning>
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor, to return a specific page of results. Cursors can be
            found from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTransactionalsResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/transactional-emails:
    get:
      operationId: listTransactionalEmails
      tags:
        - Transactional emails
      summary: List transactional emails
      description: Retrieve a paginated list of transactional emails, most recently
        created first.
      x-mint:
        href: /api-reference/list-transactional-emails
        metadata:
          sidebarTitle: List transactionals
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTransactionalsResourceResponse"
        "400":
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: createTransactionalEmail
      tags:
        - Transactional emails
      summary: Create a transactional email
      description: Create a new transactional email. An empty draft email message is
        created automatically and its `draftEmailMessageId` is returned. Use the
        `POST /v1/email-messages/{emailMessageId}` endpoint along with the
        returned `draftEmailMessageContentRevisionId` to set subject, sender,
        preview text, and LMX content, then call `POST
        /v1/transactional-emails/{transactionalId}/publish` to publish the
        draft.
      x-mint:
        href: /api-reference/create-transactional-email
        content: >-
          This endpoint creates a transactional email and an empty draft email
          message in one step.


          Use the returned `draftEmailMessageId` and
          `draftEmailMessageContentRevisionId` when calling the [Update email
          message](/api-reference/update-email-message) endpoint to set subject,
          sender, preview text, and LMX content.


          Call [Publish transactional email
          draft](/api-reference/publish-transactional-email) to publish.
        metadata:
          sidebarTitle: Create transactional
          description: Create a new transactional email and its draft email message, ready
            for editing, previewing, and publishing through the Loops API.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTransactionalRequest"
      responses:
        "201":
          description: Transactional email created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalDraftResponse"
        "400":
          description: Invalid request body or no sending domain configured.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/transactional-emails/{transactionalId}:
    parameters:
      - name: transactionalId
        in: path
        required: true
        description: The ID of the transactional email.
        schema:
          type: string
          examples:
            - cll42l54f20i1la0lfooe3z12
    get:
      operationId: getTransactionalEmail
      tags:
        - Transactional emails
      summary: Get a transactional email
      description: Retrieve a single transactional email by ID.
      x-mint:
        href: /api-reference/get-transactional-email
        metadata:
          sidebarTitle: Get transactional
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalResource"
        "400":
          description: Invalid `transactionalId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: updateTransactionalEmail
      tags:
        - Transactional emails
      summary: Update a transactional email
      description: Update a transactional email's name or group. At least one field
        must be provided.
      x-mint:
        href: /api-reference/update-transactional-email
        metadata:
          sidebarTitle: Update transactional
          description: Update a transactional email's name or group.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTransactionalRequest"
      responses:
        "200":
          description: Transactional email updated.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalResource"
        "400":
          description: Invalid request body or `transactionalId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/transactional-emails/{transactionalId}/metrics:
    parameters:
      - name: transactionalId
        in: path
        required: true
        description: The ID of the transactional email.
        schema:
          type: string
          examples:
            - cll42l54f20i1la0lfooe3z12
    get:
      operationId: getTransactionalEmailMetrics
      tags:
        - Transactional emails
      summary: Get transactional email metrics
      description: Retrieve all-time delivery metrics for a transactional email,
        totalled across every published version.
      x-mint:
        href: /api-reference/get-transactional-email-metrics
        metadata:
          description: Retrieve all-time delivery metrics for a transactional email.
          sidebarTitle: Get metrics
        content: Metrics are totalled across every published version of the
          transactional email.
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalMetricsResponse"
        "400":
          description: Invalid `transactionalId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/transactional-emails/{transactionalId}/draft:
    parameters:
      - name: transactionalId
        in: path
        required: true
        description: The ID of the transactional email.
        schema:
          type: string
          examples:
            - cll42l54f20i1la0lfooe3z12
    post:
      operationId: ensureTransactionalDraft
      tags:
        - Transactional emails
      summary: Ensure a draft email message
      description: Ensure the transactional email has a draft email message. If a
        draft already exists it is returned unchanged; otherwise a new empty
        draft is created (seeded from the most recent published version when
        present). Use `POST /v1/email-messages/{emailMessageId}` to edit the
        draft's content.
      x-mint:
        href: /api-reference/ensure-transactional-draft
        content: >-
          If a draft email message already exists, it is returned unchanged.
          Otherwise a new empty draft is created (seeded from the most recent
          published version when present).


          Use the returned `draftEmailMessageId` and
          `draftEmailMessageContentRevisionId` when calling [Update an email
          message](/api-reference/update-email-message) to edit the draft's
          content.
        metadata:
          title: Ensure a transactional email has a draft
          sidebarTitle: Ensure draft
          description: Ensure a transactional email has a draft email message ready for
            editing, creating one from the published version if no draft
            currently exists.
      responses:
        "200":
          description: Draft ready.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalDraftResponse"
        "400":
          description: Invalid `transactionalId` or no sending domain configured.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/transactional-emails/{transactionalId}/publish:
    parameters:
      - name: transactionalId
        in: path
        required: true
        description: The ID of the transactional email.
        schema:
          type: string
          examples:
            - cll42l54f20i1la0lfooe3z12
    post:
      operationId: publishTransactionalEmail
      tags:
        - Transactional emails
      summary: Publish a transactional email draft
      description: Publish the transactional email's current draft email message. The
        draft becomes the published version and the draft is cleared.
      x-mint:
        href: /api-reference/publish-transactional-email
        content: >-
          The transactional email's current draft email message is published.
          The draft becomes the published version and the draft is cleared.


          After publishing, use the returned `id` as `transactionalId` with
          [Send a transactional email](/api-reference/send-transactional-email)
          to send the email.
        metadata:
          title: Publish a transactional email
          sidebarTitle: Publish transactional
      responses:
        "200":
          description: Transactional email published.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalResource"
        "400":
          description: Invalid `transactionalId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: No draft to publish.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
        "422":
          description: Draft failed validation, sending domain is not verified, or content
            was flagged as unsafe.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionalFailureResponse"
      security:
        - apiKey: []
  /v1/transactional-groups:
    get:
      operationId: listTransactionalGroups
      tags:
        - Transactional groups
      summary: List transactional groups
      description: Retrieve a paginated list of transactional groups, most recently
        created first.
      x-mint:
        href: /api-reference/list-transactional-groups
        metadata:
          sidebarTitle: List groups
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListGroupsResponse"
        "400":
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: createTransactionalGroup
      tags:
        - Transactional groups
      summary: Create a transactional group
      description: Create a new transactional group.
      x-mint:
        href: /api-reference/create-transactional-group
        metadata:
          sidebarTitle: Create a group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateGroupRequest"
      responses:
        "200":
          description: Transactional group created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid request body or reserved group name.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/transactional-groups/{transactionalGroupId}:
    parameters:
      - name: transactionalGroupId
        in: path
        required: true
        description: The ID of the transactional group.
        schema:
          type: string
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
    get:
      operationId: getTransactionalGroup
      tags:
        - Transactional groups
      summary: Get a transactional group
      description: Retrieve a single transactional group by ID.
      x-mint:
        href: /api-reference/get-transactional-group
        metadata:
          sidebarTitle: Get a group
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid `transactionalGroupId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Transactional group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: updateTransactionalGroup
      tags:
        - Transactional groups
      summary: Update a transactional group
      description: Update a transactional group's name or description. At least one
        field must be provided. The reserved "Unsorted" group cannot be edited.
      x-mint:
        href: /api-reference/update-transactional-group
        content: <Info>At least one field must be provided. The reserved "Unsorted"
          group cannot be edited.</Info>
        metadata:
          sidebarTitle: Update a group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateGroupRequest"
      responses:
        "200":
          description: Transactional group updated.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid request body, reserved group name, or the Unsorted group
            cannot be edited.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Transactional group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/uploads:
    post:
      operationId: createUpload
      tags:
        - Uploads
      summary: Create an upload
      description: Request a pre-signed URL to upload an image asset. Upload the file
        with an HTTP `PUT` to the returned `presignedUrl` (sending the same
        `Content-Type` and `Content-Length`), then call
        `/uploads/{emailAssetId}/complete` to finalize the asset.
      x-mint:
        href: /api-reference/create-upload
        content: Request a pre-signed URL to upload an image asset. Upload the file with
          an HTTP `PUT` to the returned `presignedUrl` (sending the same
          `Content-Type` and `Content-Length`), then call [Complete an
          upload](/api-reference/complete-upload) to finalize the asset.
        metadata:
          description: Request a pre-signed URL to upload an image asset.
          sidebarTitle: Create an upload
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateUploadRequest"
      responses:
        "200":
          description: Pre-signed upload URL created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateUploadResponse"
        "400":
          description: Invalid request body or unsupported `contentType`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UploadFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "405":
          description: Wrong HTTP request method.
        "413":
          description: Upload exceeds the maximum allowed size.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UploadFailureResponse"
      security:
        - apiKey: []
  /v1/uploads/{emailAssetId}/complete:
    parameters:
      - name: emailAssetId
        in: path
        required: true
        description: The `emailAssetId` returned when the upload was created via `POST
          /v1/uploads`.
        schema:
          type: string
          examples:
            - cla3s5s7e9t1i3d5f7g9h1j3
    post:
      operationId: completeUpload
      tags:
        - Uploads
      summary: Complete an upload
      description: Finalize an image upload after the file has been uploaded to the
        pre-signed URL. Returns the public URL of the uploaded image asset.
      x-mint:
        href: /api-reference/complete-upload
        metadata:
          description: Finalize an image upload after the file has been uploaded to the
            pre-signed URL.
      responses:
        "200":
          description: Upload completed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CompleteUploadResponse"
        "400":
          description: Upload id is missing or the uploaded file has an unsupported
            content type.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UploadFailureResponse"
        "401":
          description: Invalid API key or content API not enabled for this team.
        "404":
          description: Upload not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UploadFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "429":
          description: Upload limit exceeded.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UploadLimitExceededFailureResponse"
      security:
        - apiKey: []
  /v1/workflow-groups:
    get:
      operationId: listWorkflowGroups
      tags:
        - Workflow groups
      summary: List workflow groups
      description: Retrieve a paginated list of workflow groups, most recently created
        first.
      x-mint:
        href: /api-reference/list-workflow-groups
        metadata:
          sidebarTitle: List groups
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListGroupsResponse"
        "400":
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: createWorkflowGroup
      tags:
        - Workflow groups
      summary: Create a workflow group
      description: Create a new workflow group.
      x-mint:
        href: /api-reference/create-workflow-group
        metadata:
          sidebarTitle: Create a group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateGroupRequest"
      responses:
        "200":
          description: Workflow group created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid request body or reserved group name.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/workflow-groups/{workflowGroupId}:
    parameters:
      - name: workflowGroupId
        in: path
        required: true
        description: The ID of the workflow group.
        schema:
          type: string
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
    get:
      operationId: getWorkflowGroup
      tags:
        - Workflow groups
      summary: Get a workflow group
      description: Retrieve a single workflow group by ID.
      x-mint:
        href: /api-reference/get-workflow-group
        metadata:
          sidebarTitle: Get a group
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid `workflowGroupId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      operationId: updateWorkflowGroup
      tags:
        - Workflow groups
      summary: Update a workflow group
      description: Update a workflow group's name or description. At least one field
        must be provided. The reserved "Unsorted" group cannot be edited.
      x-mint:
        href: /api-reference/update-workflow-group
        content: <Info>At least one field must be provided. The reserved "Unsorted"
          group cannot be edited.</Info>
        metadata:
          description: Update a workflow group's name or description.
          sidebarTitle: Update a group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateGroupRequest"
      responses:
        "200":
          description: Workflow group updated.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupResponse"
        "400":
          description: Invalid request body, reserved group name, or the Unsorted group
            cannot be edited.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GroupFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/workflows:
    get:
      tags:
        - Workflows
      summary: List workflows
      operationId: listWorkflows
      description: Retrieve a paginated list of workflows.
      x-mint:
        href: /api-reference/list-workflows
      parameters:
        - name: perPage
          in: query
          required: false
          description: How many results to return in each request. Must be between 10 and
            50. Default is 20.
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: A cursor to return a specific page of results. Cursors can be found
            from the `pagination.nextCursor` value in each response.
          schema:
            type: string
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListWorkflowsResponse"
        "400":
          description: Invalid `perPage` or `cursor` value.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      tags:
        - Workflows
      summary: Create a workflow
      operationId: createWorkflow
      description: Create a draft workflow with a blank trigger and exit node. When
        `workflowGroupId` is omitted, the workflow is added to the team's
        Unsorted group.
      x-mint:
        href: /api-reference/create-workflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateWorkflowRequest"
      responses:
        "200":
          description: Workflow created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SimplifiedWorkflow"
        "400":
          description: Invalid request body or workflow group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/workflows/{workflowId}:
    parameters:
      - name: workflowId
        in: path
        required: true
        description: The ID of the workflow.
        schema:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
    get:
      tags:
        - Workflows
      summary: Get a workflow
      operationId: getWorkflow
      description: Retrieve a workflow graph with node type names, connections, and
        selected display fields.
      x-mint:
        content: Returns a simplified view of the workflow graph. Each node includes its
          `typeName`, outgoing connections in `nextNodeIds`, and selected
          display fields. Use [Get a workflow
          node](/api-reference/get-workflow-node) to retrieve full details for a
          single node.
        href: /api-reference/get-workflow
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SimplifiedWorkflow"
        "400":
          description: Invalid `workflowId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      tags:
        - Workflows
      summary: Update a workflow
      operationId: updateWorkflowProperties
      description: Update a workflow's name, description, or group. At least one field
        must be provided. To change the workflow's mailing list, use the `POST
        /v1/workflows/{workflowId}/mailing-list` endpoint instead.
      x-mint:
        href: /api-reference/update-workflow
        content: <Info>To change a workflow's mailing list, use the [Change workflow
          mailing list](/api-reference/change-workflow-mailing-list) endpoint
          instead. This is because changing mailing lists may remove queued
          contacts from the workflow.</Info>
        metadata:
          description: Update a workflow's name, description, or group.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateWorkflowPropertiesRequest"
      responses:
        "200":
          description: Workflow properties updated.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SimplifiedWorkflow"
        "400":
          description: Invalid `workflowId`, request body, or workflow group not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
      security:
        - apiKey: []
    delete:
      tags:
        - Workflows
      summary: Delete a workflow
      operationId: deleteWorkflow
      description: "Delete a workflow. Successful deletion returns `204 No Content`.
        If the workflow is currently sending or has queued contacts, Loops
        returns `409 Conflict` with a message instead of deleting. Retry with
        `confirmDelete: true` to delete the workflow, stop sending, and cancel
        queued contacts."
      x-mint:
        href: /api-reference/delete-workflow
        content: >-
          Deleting a sending workflow stops sending it. Additionally, if the
          workflow has queued contacts, they are removed.


          Successful deletion returns `204 No Content`. If the workflow is
          currently sending or has queued contacts, Loops returns `409 Conflict`
          with a `message` instead of deleting. Retry the request with the same
          `expectedRevisionId` and `confirmDelete: true` to delete the workflow.


          Once deleted, workflows are not returned in other API endpoints.
        metadata:
          sidebarTitle: Delete a workflow
          description: Delete a workflow with revision and confirmation handling.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteWorkflowRequest"
      responses:
        "204":
          description: Workflow deleted. No response body.
        "400":
          description: Invalid `workflowId`, request body, or delete target.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow not found. Deleted workflows are returned as not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale, or workflow deletion requires
            confirmation because the workflow is currently sending or has queued
            contacts."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
              examples:
                staleRevision:
                  summary: "`expectedRevisionId` is stale"
                  value:
                    message: workflowRevisionId mismatch. Latest workflowRevisionId is
                      clx7a3b5c7d9e1f3g5h7i9j1. Refetch and retry.
                confirmationRequiredSending:
                  summary: Workflow is currently sending
                  value:
                    message: "This workflow is currently sending. Deleting it will stop sending it.
                      Confirm deletion by sending a second request with
                      confirmDelete: true."
                confirmationRequiredQueuedContacts:
                  summary: Workflow has queued contacts
                  value:
                    message: "This workflow has 3 queued contacts. Deleting it will cancel those
                      queued contacts. Confirm deletion by sending a second
                      request with confirmDelete: true."
                confirmationRequiredSendingAndQueuedContacts:
                  summary: Workflow is sending and has queued contacts
                  value:
                    message: "This workflow is currently sending and has 3 queued contacts. Deleting
                      it will stop sending it and cancel those queued contacts.
                      Confirm deletion by sending a second request with
                      confirmDelete: true."
      security:
        - apiKey: []
  /v1/workflows/{workflowId}/mailing-list:
    parameters:
      - name: workflowId
        in: path
        required: true
        description: The ID of the workflow.
        schema:
          type: string
    post:
      tags:
        - Workflows
      summary: Change workflow mailing list
      operationId: changeWorkflowMailingList
      description: 'Dry run or apply a workflow mailing list change. If queued
        contacts would be removed from the workflow due to the change of mailing
        list, Loops returns with `"status": "queuedContactsFound"` instead of
        applying the change. Retry with `queuedContactPolicy: "discard"` to
        apply the change and discard those contacts. Confirmed update responses
        include the simplified workflow after the mailing list changes.'
      x-mint:
        href: /api-reference/change-workflow-mailing-list
        content: >-
          Use this endpoint to change a workflow's mailing list.


          Make a dry run request using `dryRun: true`.


          If queued contacts would be removed from the workflow due to the
          change of mailing list, Loops returns with `"status":
          "queuedContactsFound"` instead of applying the change. Retry with
          `queuedContactPolicy: "discard"` to apply the change and discard those
          contacts.


          Confirmed update responses include the simplified workflow after the
          mailing list changes.
        metadata:
          sidebarTitle: Change mailing list
          description: Change a workflow's mailing list.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChangeWorkflowMailingListRequest"
      responses:
        "200":
          description: Mailing-list dry run, queued-contact warning, or update result.
            Confirmed update responses include the simplified workflow after the
            mailing list changes.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ChangeWorkflowMailingListResponse"
        "400":
          description: Invalid `workflowId`, request body, mailing list, or workflow state.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
      security:
        - apiKey: []
  /v1/workflows/{workflowId}/nodes:
    parameters:
      - name: workflowId
        in: path
        required: true
        description: The ID of the workflow.
        schema:
          type: string
    post:
      tags:
        - Workflow nodes
      summary: Create a workflow node
      operationId: createWorkflowNode
      description: >-
        Create a new default workflow node and return it with the latest
        workflow.


        Choose where the node goes with `insertMode`: `between` places it
        between an existing `fromNodeId` -> `toNodeId` connection, `before`
        places it before `toNodeId`, and `after` places it after `fromNodeId`
        when that node has exactly one outgoing connection. `after` is a
        convenience for simple linear paths, so callers do not need to fetch and
        pass the current child node ID. It is invalid when `fromNodeId` has no
        outgoing nodes, multiple outgoing nodes, or is an exit node. When the
        source has multiple outgoing nodes, use `between` with the exact
        `toNodeId` instead. For `before`, deprecated `beforeNodeId` requests are
        still accepted for compatibility, but new callers should use `toNodeId`.


        New nodes start with default settings; update the node after creation to
        configure it. Branch nodes create their default paths too: `BranchNode`
        creates two `AudienceFilter` children, and `ExperimentBranchNode`
        creates two regular `VariantNode` children plus one control
        `VariantNode`. Public workflows can have up to 400 nodes. Generated
        children count toward that limit, so a normal create adds 1 node,
        `BranchNode` adds 3, and `ExperimentBranchNode` adds 4. To add a sibling
        child path to a branch or experiment branch, use the `POST
        /v1/workflows/{workflowId}/nodes/{nodeId}/add-branch` endpoint. Branch
        paths can be edited with create-node, but a workflow cannot be started
        unless each direct `BranchNode` child is an `AudienceFilter`. For
        experiments, use create-node only to insert a missing `VariantNode`
        before non-variant content; use add-branch for another variant path.
      x-mint:
        href: /api-reference/create-workflow-node
        content: >-
          Choose where the node goes with `insertMode`:

          - `between` places it between an existing `fromNodeId` -> `toNodeId`
          connection

          - `before` places it before `toNodeId`

          - `after` places it after `fromNodeId` when that node has exactly one
          outgoing connection.


          Use `after` for simple linear paths when you do not want to fetch and
          pass the current child node ID. `after` is invalid when `fromNodeId`
          has no outgoing nodes, multiple outgoing nodes, or is an exit node.
          When the source has multiple outgoing nodes, use `between` with the
          exact `toNodeId` instead. For `before`, deprecated `beforeNodeId`
          requests are still accepted for compatibility, but new callers should
          use `toNodeId`.


          New nodes start with default settings; update the node after creation
          to configure it. Branch nodes create their default paths too:
          `BranchNode` creates two `AudienceFilter` children, and
          `ExperimentBranchNode` creates two regular `VariantNode` children plus
          one control `VariantNode`.


          Public workflows can have up to 400 nodes. Generated children count
          toward that limit, so a normal create adds 1 node, `BranchNode` adds
          3, and `ExperimentBranchNode` adds 4. To add a sibling child path to a
          branch or experiment branch, use the `POST
          /v1/workflows/{workflowId}/nodes/{nodeId}/add-branch` endpoint. Branch
          paths can be edited with create-node, but a workflow cannot be started
          unless each direct `BranchNode` child is an `AudienceFilter`. For
          experiments, use create-node only to insert a missing `VariantNode`
          before non-variant content; use add-branch for another variant path.
        metadata:
          sidebarTitle: Create a node
          description: Create a new default workflow node and return it with the latest
            workflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateWorkflowNodeRequest"
      responses:
        "200":
          description: Workflow node created.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateWorkflowNodeResponse"
        "400":
          description: Invalid request. Details will be shown in `message`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow or workflow node not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
      security:
        - apiKey: []
  /v1/workflows/{workflowId}/nodes/{nodeId}/add-branch:
    parameters:
      - name: workflowId
        in: path
        required: true
        description: The ID of the workflow.
        schema:
          type: string
      - name: nodeId
        in: path
        required: true
        description: The ID of the BranchNode or ExperimentBranchNode that should
          receive one new child.
        schema:
          type: string
    post:
      tags:
        - Workflow nodes
      summary: Add a branch
      operationId: addWorkflowBranch
      description: >-
        Add a branch and a child node under an existing Branch or Experiment
        node. Returns the created child node plus the latest workflow.


        - Adding a branch to a `BranchNode` creates one `AudienceFilter` child
        node.

        - Adding a branch to an `ExperimentBranchNode` creates one `VariantNode`
        child node.


        This endpoint does not accept node configuration fields; update the
        child node with `POST /v1/workflows/{workflowId}/nodes/{nodeId}` after
        creation. Public workflows are limited to 400 nodes, and this endpoint
        adds 1 node.
      x-mint:
        href: /api-reference/add-workflow-branch
        content: >-
          Adding a branch to a `BranchNode` creates one `AudienceFilter` child
          node.

          Adding a branch to an `ExperimentBranchNode` creates one `VariantNode`
          child node.


          This endpoint does not accept node configuration fields; [update the
          child node](/api-reference/update-workflow-node) after creation.
          Public workflows are limited to 400 nodes, and this endpoint adds 1
          node.
        metadata:
          sidebarTitle: Add a branch
          description: Add a branch and a child node under an existing Branch or
            Experiment node.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddWorkflowBranchRequest"
      responses:
        "200":
          description: Branch added.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AddWorkflowBranchResponse"
        "400":
          description: Invalid `workflowId`, `nodeId`, request body, branch target,
            workflow state, or workflow node cap.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow or workflow node not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
      security:
        - apiKey: []
  /v1/workflows/{workflowId}/nodes/{nodeId}:
    parameters:
      - name: workflowId
        in: path
        required: true
        description: The ID of the workflow.
        schema:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
      - name: nodeId
        in: path
        required: true
        description: The ID of the workflow node.
        schema:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
    get:
      tags:
        - Workflow nodes
      summary: Get a workflow node
      operationId: getWorkflowNode
      description: Retrieve detailed data for a single workflow node.
      x-mint:
        href: /api-reference/get-workflow-node
        metadata:
          sidebarTitle: Get a node
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowNodeWithRevision"
        "400":
          description: Invalid `workflowId` or `nodeId`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow or workflow node not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
    post:
      tags:
        - Workflow nodes
      summary: Update a workflow node
      operationId: updateWorkflowNode
      description: Update workflow-node-owned fields for a single node. Shared
        resources such as email messages and audience segments should be updated
        through their own APIs.
      x-mint:
        href: /api-reference/update-workflow-node
        content: Shared resources such as email messages and audience segments should be
          updated through their own APIs.
        metadata:
          sidebarTitle: Update a node
          description: Update workflow-node-owned fields for a single node.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateWorkflowNodeRequest"
      responses:
        "200":
          description: Workflow node updated.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateWorkflowNodeResponse"
        "400":
          description: Invalid `workflowId`, `nodeId`, request body, or node update.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow or workflow node not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "501":
          description: This node update is not implemented.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
      security:
        - apiKey: []
    delete:
      tags:
        - Workflow nodes
      summary: Delete a workflow node
      operationId: deleteWorkflowNode
      description: 'Delete a single workflow node. If contacts are queued at the node,
        Loops returns with `"status": "queuedContactsFound"` instead of
        deleting. Retry with `queuedContactPolicy: "discard"` to delete the node
        and discard those queued contacts. Confirmed deletion responses include
        the simplified workflow after the node is removed.'
      x-mint:
        href: /api-reference/delete-workflow-node
        content: >-
          Delete a node from a workflow.


          Make a dry run request using `dryRun: true`.


          If contacts are queued at the node, Loops returns with `"status":
          "queuedContactsFound"` instead of deleting. Retry with
          `queuedContactPolicy: "discard"` to delete the node and discard those
          queued contacts.


          Confirmed deletion responses include the simplified workflow after the
          node is removed.
        metadata:
          sidebarTitle: Delete a node
          description: Delete a single workflow node.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteWorkflowNodeRequest"
      responses:
        "200":
          description: Delete dry run, queued-contact warning, or deletion result.
            Confirmed deletion responses include the simplified workflow after
            the node is removed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteWorkflowNodeResponse"
        "400":
          description: Invalid `workflowId`, `nodeId`, request body, or delete target.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow or workflow node not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
      security:
        - apiKey: []
  /v1/workflows/{workflowId}/nodes/{nodeId}/metrics:
    parameters:
      - name: workflowId
        in: path
        required: true
        description: The ID of the workflow.
        schema:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
      - name: nodeId
        in: path
        required: true
        description: The ID of the `SendEmailAction` node.
        schema:
          type: string
          examples:
            - cln1a3b5c7d9e1f3g5h7i9j1
    get:
      operationId: getWorkflowNodeMetrics
      tags:
        - Workflow nodes
      summary: Get workflow node metrics
      description: Retrieve all-time email engagement metrics for a workflow
        `SendEmailAction` node. Nodes of any other type return a `400` response.
        A `SendEmailAction` node with an email that has not sent anything yet
        reports every counter as `0`.
      x-mint:
        href: /api-reference/get-workflow-node-metrics
        metadata:
          description: Retrieve all-time email engagement metrics for a workflow email node.
          sidebarTitle: Get metrics
        content: Metrics are only available for `SendEmailAction` nodes. Nodes of any
          other type return a `400` response. A `SendEmailAction` node whose
          email has not sent anything yet reports every counter as `0`.
      responses:
        "200":
          description: Successful.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmailMetricsResponse"
        "400":
          description: Invalid `workflowId` or `nodeId`, the node is not a
            `SendEmailAction` node, or the node has no email message.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow or workflow node not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
      security:
        - apiKey: []
  /v1/workflows/{workflowId}/nodes/{nodeId}/reroute:
    parameters:
      - name: workflowId
        in: path
        required: true
        description: The ID of the workflow.
        schema:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
      - name: nodeId
        in: path
        required: true
        description: The ID of the source workflow node whose outgoing connection should
          be moved.
        schema:
          type: string
          examples:
            - cln1a3b5c7d9e1f3g5h7i9j1
    post:
      tags:
        - Workflow nodes
      summary: Reroute a node connection
      operationId: rerouteNodeConnection
      description: Reroute the source node's existing connection to another valid
        target node. Returns the updated source node and the latest workflow.
      x-mint:
        href: /api-reference/reroute-node-connection
        content: >-
          Use this endpoint to modify an existing node connection to another
          target. Send the source node in the URL path and the new target in the
          request body.


          The source node must have exactly one outgoing connection. Branch and
          experiment branch nodes cannot be rerouted with this endpoint because
          they have multiple branch-specific outputs. The current target must
          still have another incoming connection after the reroute, and the new
          target must be valid for the source node. The workflow cannot be
          edited while in a `SENDING` state.
        metadata:
          sidebarTitle: Reroute a node
          description: Reroute one existing node connection to another valid target node.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RerouteNodeConnectionRequest"
      responses:
        "200":
          description: Node connection rerouted.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RerouteNodeConnectionResponse"
        "400":
          description: Invalid `workflowId`, `nodeId`, request body, node connection
            selection, reroute target, or workflow state.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow or workflow node not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
      security:
        - apiKey: []
  /v1/workflows/{workflowId}/nodes/{nodeId}/recursive:
    parameters:
      - name: workflowId
        in: path
        required: true
        description: The ID of the workflow.
        schema:
          type: string
      - name: nodeId
        in: path
        required: true
        description: The root node ID of the subtree to delete.
        schema:
          type: string
    delete:
      tags:
        - Workflow nodes
      summary: Delete workflow nodes recursively
      operationId: deleteWorkflowNodeRecursively
      description: 'Delete a node and its downstream subtree. If contacts are queued
        at any node that would be deleted, Loops returns with `"status":
        "queuedContactsFound"` instead of deleting. Retry with
        `queuedContactPolicy: "discard"` to delete the nodes and discard those
        queued contacts. Confirmed deletion responses include the simplified
        workflow after the nodes are removed.'
      x-mint:
        href: /api-reference/delete-workflow-nodes
        content: >-
          Delete a node and its downstream subtree.


          Make a dry run request using `dryRun: true`.


          If contacts are queued at any node that would be deleted, Loops
          returns with `"status": "queuedContactsFound"` instead of deleting.
          Retry with `queuedContactPolicy: "discard"` to delete the nodes and
          discard those queued contacts.


          Confirmed deletion responses include the simplified workflow after the
          nodes are removed.
        metadata:
          sidebarTitle: Delete nodes
          description: Delete a node and its downstream subtree.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteWorkflowNodeRequest"
      responses:
        "200":
          description: Delete dry run, queued-contact warning, or deletion result.
            Confirmed deletion responses include the simplified workflow after
            the nodes are removed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteWorkflowNodeResponse"
        "400":
          description: Invalid `workflowId`, `nodeId`, request body, or delete target.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "401":
          description: Invalid API key.
        "404":
          description: Workflow or workflow node not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
        "405":
          description: Wrong HTTP request method.
        "409":
          description: "`expectedRevisionId` is stale."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowFailureResponse"
      security:
        - apiKey: []
webhooks:
  contactUnsubscribed:
    post:
      operationId: webhookContactUnsubscribed
      x-excluded: true
      summary: Contact unsubscribed
      description: Sent when a contact is unsubscribed from your audience, or when a
        contact is deleted from your audience (alongside `contact.deleted`).
        This is not the same as a contact unsubscribing from a mailing list (see
        `contact.mailingList.unsubscribed`). Contains a `contactIdentity`
        object.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookContactUnsubscribedPayload"
            example:
              eventName: contact.unsubscribed
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  contactCreated:
    post:
      operationId: webhookContactCreated
      x-excluded: true
      summary: Contact created
      description: Sent when a new contact is created in your audience. Contains a
        `contactIdentity` object and a full `contact` object with all of the new
        contact's properties (including custom properties). When double opt-in
        is enabled, contact webhooks do not fire until the contact is confirmed;
        `contact.created` only fires for form-created contacts once they confirm
        their subscription. `optInStatus` will never be `"pending"` or
        `"rejected"` for this event.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookContactCreatedPayload"
            example:
              eventName: contact.created
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              contactIdentity:
                id: cm4itta800003ow9hhekzk94o
                email: test+5@loops.so
                userId: null
              contact:
                id: cm4itta800003ow9hhekzk94o
                email: test+5@loops.so
                firstName: null
                lastName: null
                source: API
                subscribed: true
                userGroup: ""
                userId: null
                mailingLists:
                  cm4ittp2k000l12j3lgrzvlxt: true
                optInStatus: accepted
                favoriteColor: blue
                favoriteNumber: 42
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  contactDeleted:
    post:
      operationId: webhookContactDeleted
      x-excluded: true
      summary: Contact deleted
      description: Sent when a contact is deleted from your audience. Contains a
        `contactIdentity` object.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookContactDeletedPayload"
            example:
              eventName: contact.deleted
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  contactMailingListSubscribed:
    post:
      operationId: webhookContactMailingListSubscribed
      x-excluded: true
      summary: Contact subscribed to mailing list
      description: Sent when a contact is subscribed to a mailing list. Contains
        `contactIdentity` and `mailingList` objects. When double opt-in is
        enabled, this event only fires after the contact confirms their
        subscription.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookContactMailingListSubscribedPayload"
            example:
              eventName: contact.mailingList.subscribed
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
              mailingList:
                id: cm4ittp2k000l12j3lgrzvlxt
                name: test mailing list
                description: null
                isPublic: true
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  contactMailingListUnsubscribed:
    post:
      operationId: webhookContactMailingListUnsubscribed
      x-excluded: true
      summary: Contact unsubscribed from mailing list
      description: Sent when a contact is unsubscribed from a mailing list. This is
        not the same as a contact unsubscribing from your audience (see
        `contact.unsubscribed`). Contains `contactIdentity` and `mailingList`
        objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookContactMailingListUnsubscribedPayload"
            example:
              eventName: contact.mailingList.unsubscribed
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
              mailingList:
                id: cm4ittp2k000l12j3lgrzvlxt
                name: test mailing list
                description: null
                isPublic: true
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  transactionalEmailSent:
    post:
      operationId: webhookTransactionalEmailSent
      x-excluded: true
      summary: Transactional email sent
      description: Sent when a transactional email is sent to a contact. Contains a
        `transactionalId` value plus `contactIdentity` and `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookTransactionalEmailSentPayload"
            example:
              eventName: transactional.email.sent
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
              transactionalId: cm4t1suns001uw6atri87v54s
              transactionalName: Test Transactional
              email:
                id: cm4t1sseg004tje7982991nan
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  campaignEmailSent:
    post:
      operationId: webhookCampaignEmailSent
      x-excluded: true
      summary: Campaign email sent
      description: Sent when a campaign email is sent to a contact. This event fires
        for every campaign send (for example, sending to 1,000 contacts produces
        1,000 events). Contains `campaignId` and `campaignName` plus
        `contactIdentity` and `email` objects. If the campaign was sent to one
        or more mailing lists, a `mailingLists` array is also included.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookCampaignEmailSentPayload"
            example:
              eventName: campaign.email.sent
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
              campaignId: cm4t1suns001uw6atri87v54s
              campaignName: Test Campaign
              email:
                id: cm4t1sv84004yje79hawr1fi1
                emailMessageId: cm4t1suns001ww6atotin3bn1
                subject: Test Subject
              mailingLists:
                - id: cm4ittp2k000l12j3lgrzvlxt
                  name: test mailing list
                  description: null
                  isPublic: true
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  loopEmailSent:
    post:
      operationId: webhookLoopEmailSent
      x-excluded: true
      summary: Loop email sent
      description: Sent when a workflow email is sent to a contact. This event keeps
        its `loop` naming for compatibility (Loops was renamed to Workflows on
        May 6, 2026). This event fires for every contact in a workflow (for
        example, 1,000 recipients produces 1,000 events). Contains `loopId` and
        `loopName` plus `contactIdentity` and `email` objects. If the workflow
        was sent to one or more mailing lists, a `mailingLists` array is also
        included.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookLoopEmailSentPayload"
            example:
              eventName: loop.email.sent
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
              loopId: cm4t1snfj0052icemfshgqfcw
              loopName: Test Loop
              email:
                id: cm4t1socj004mje79e61mgh7d
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              mailingLists:
                - id: cm4ittp2k000l12j3lgrzvlxt
                  name: test mailing list
                  description: null
                  isPublic: true
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  emailDelivered:
    post:
      operationId: webhookEmailDelivered
      x-excluded: true
      summary: Email delivered
      description: Sent when an email is delivered to its recipient. Contains
        `sourceType` (`campaign`, `loop`, or `transactional`) and the related
        `campaignId`, `loopId` (workflow ID), or `transactionalId`, plus
        `contactIdentity` and `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookEmailDeliveredPayload"
            example:
              eventName: email.delivered
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              sourceType: campaign
              campaignId: cm4t1suns001uw6atri87v54s
              email:
                id: cm4t1sseg004tje7982991nan
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  emailSoftBounced:
    post:
      operationId: webhookEmailSoftBounced
      x-excluded: true
      summary: Email soft bounced
      description: Sent when an email soft bounces. Soft bounces are temporary
        delivery failures (for example, a connection timing out). Soft bounces
        are retried multiple times and the email may still be delivered.
        Contains `sourceType` and the related `campaignId`, `loopId` (workflow
        ID), or `transactionalId`, plus `contactIdentity` and `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookEmailSoftBouncedPayload"
            example:
              eventName: email.softBounced
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              sourceType: campaign
              campaignId: cm4t1suns001uw6atri87v54s
              email:
                id: cm4t1sseg004tje7982991nan
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  emailHardBounced:
    post:
      operationId: webhookEmailHardBounced
      x-excluded: true
      summary: Email hard bounced
      description: Sent when an email hard bounces. Hard bounces are persistent
        delivery failures (for example, a mailbox that does not exist); the
        email will not be delivered. In Loops, a hard bounce also unsubscribes
        the contact from your audience, so a `contact.unsubscribed` event will
        also be sent. Contains `sourceType` and the related `campaignId`,
        `loopId` (workflow ID), or `transactionalId`, plus `contactIdentity` and
        `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookEmailHardBouncedPayload"
            example:
              eventName: email.hardBounced
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              sourceType: campaign
              campaignId: cm4t1suns001uw6atri87v54s
              email:
                id: 9874cm4t1sseg004tje7982991nan8732843
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  emailClicked:
    post:
      operationId: webhookEmailClicked
      x-excluded: true
      summary: Email clicked
      description: Sent when a link in a campaign or workflow email is clicked. Not
        available for transactional emails because link clicks are not tracked
        for transactional emails. Contains `sourceType` and the related
        `campaignId` or `loopId` (workflow ID), plus `contactIdentity` and
        `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookEmailClickedPayload"
            example:
              eventName: email.clicked
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              sourceType: campaign
              campaignId: cm4t1suns001uw6atri87v54s
              email:
                id: cm4t1sseg004tje7982991nan
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  emailUnsubscribed:
    post:
      operationId: webhookEmailUnsubscribed
      x-excluded: true
      summary: Email unsubscribed
      description: Sent when a recipient unsubscribes from marketing email or a
        mailing list using an email's "Unsubscribe" link. A
        `contact.unsubscribed` or `contact.mailingList.unsubscribed` event will
        also be sent depending on whether the email was sent to a mailing list.
        Not available for transactional emails because unsubscribe links are not
        included for transactional emails. Contains `sourceType` and the related
        `campaignId` or `loopId` (workflow ID), plus `contactIdentity` and
        `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookEmailUnsubscribedPayload"
            example:
              eventName: email.unsubscribed
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              sourceType: campaign
              campaignId: cm4t1suns001uw6atri87v54s
              email:
                id: cm4t1sseg004tje7982991nan
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  emailResubscribed:
    post:
      operationId: webhookEmailResubscribed
      x-excluded: true
      summary: Email resubscribed
      description: Sent when a recipient resubscribes to marketing email from an
        email's preference center ("Unsubscribe" link). Not available for
        transactional emails because unsubscribe links are not included for
        transactional emails. Contains `sourceType` and the related `campaignId`
        or `loopId` (workflow ID), plus `contactIdentity` and `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookEmailResubscribedPayload"
            example:
              eventName: email.resubscribed
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              sourceType: campaign
              campaignId: cm4t1suns001uw6atri87v54s
              email:
                id: cm4t1sseg004tje7982991nan
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  emailOpened:
    post:
      operationId: webhookEmailOpened
      x-excluded: true
      summary: Email opened
      description: Sent when a campaign or workflow email is opened. Not available for
        transactional emails because email opens are not tracked for
        transactional emails. Contains `sourceType` and the related `campaignId`
        or `loopId` (workflow ID), plus `contactIdentity` and `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookEmailOpenedPayload"
            example:
              eventName: email.opened
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              sourceType: campaign
              campaignId: cm4t1suns001uw6atri87v54s
              email:
                id: cm4t1sseg004tje7982991nan
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  emailSpamReported:
    post:
      operationId: webhookEmailSpamReported
      x-excluded: true
      summary: Email spam reported
      description: Sent when a recipient reports your email as spam. Contains
        `sourceType` and the related `campaignId`, `loopId` (workflow ID), or
        `transactionalId`, plus `contactIdentity` and `email` objects.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookEmailSpamReportedPayload"
            example:
              eventName: email.spamReported
              eventTime: 1734425918
              webhookSchemaVersion: 1.0.0
              sourceType: campaign
              campaignId: cm4t1suns001uw6atri87v54s
              email:
                id: cm4t1sseg004tje7982991nan
                emailMessageId: cm4ittv1v001oow9hruou8na8
                subject: Subject of the email
              contactIdentity:
                id: cm4ittmhq0011ow9h6fb460yw
                email: test@example.com
                userId: null
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
  testingTestEvent:
    post:
      operationId: webhookTestingTestEvent
      x-excluded: true
      summary: Test event
      description: Test event that can be triggered from the Webhooks settings page in
        Loops. Use this to verify that your endpoint is working and that your
        signature verification code is correct. The payload contains
        `eventName`, `eventTime`, `message` (always `"test"`), and
        `webhookSchemaVersion`.
      tags:
        - Webhooks
      parameters:
        - $ref: "#/components/parameters/WebhookId"
        - $ref: "#/components/parameters/WebhookTimestamp"
        - $ref: "#/components/parameters/WebhookSignature"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookTestingTestEventPayload"
            example:
              eventName: testing.testEvent
              eventTime: 1734425918
              message: test
              webhookSchemaVersion: 1.0.0
      responses:
        "200":
          description: Webhook received successfully. Return any 2xx status code to
            acknowledge delivery.
      security: []
components:
  schemas:
    EmailMetricsResponse:
      type: object
      description: "All-time email engagement counters. Opens and clicks count sends,
        not events: a send opened five times counts once. A recipient who
        received the email twice is counted once per send, not once per person."
      properties:
        sends:
          type: integer
          description: Number of sends.
          examples:
            - 4210
        opens:
          type: integer
          description: Number of sends that were opened at least once.
          examples:
            - 1922
        clicks:
          type: integer
          description: Number of sends where at least one link was clicked.
          examples:
            - 301
        unsubscribes:
          type: integer
          description: Number of unsubscribes.
          examples:
            - 12
        spamReports:
          type: integer
          description: Number of sends reported as spam.
          examples:
            - 1
        hardBounces:
          type: integer
          description: Number of sends that hard bounced.
          examples:
            - 9
        softBounces:
          type: integer
          description: Number of sends that soft bounced.
          examples:
            - 13
      required:
        - sends
        - opens
        - clicks
        - unsubscribes
        - spamReports
        - hardBounces
        - softBounces
      examples:
        - sends: 4210
          opens: 1922
          clicks: 301
          unsubscribes: 12
          spamReports: 1
          hardBounces: 9
          softBounces: 13
    TransactionalMetricsResponse:
      type: object
      description: All-time delivery counters for a transactional email.
      properties:
        sends:
          type: integer
          description: Number of sends.
          examples:
            - 4210
        deliveries:
          type: integer
          description: Number of sends delivered.
          examples:
            - 4175
        spamReports:
          type: integer
          description: Number of sends reported as spam.
          examples:
            - 1
        hardBounces:
          type: integer
          description: Number of sends that hard bounced.
          examples:
            - 9
        softBounces:
          type: integer
          description: Number of sends that soft bounced.
          examples:
            - 13
      required:
        - sends
        - deliveries
        - spamReports
        - hardBounces
        - softBounces
      examples:
        - sends: 4210
          deliveries: 4175
          spamReports: 1
          hardBounces: 9
          softBounces: 13
    Contact:
      type: object
      properties:
        id:
          type: string
          description: The contact's Loops ID.
          examples:
            - clh3k9m2p4q6r8s0t2v4x6z8
        email:
          type: string
          description: The contact's email address.
          examples:
            - alex@company.com
        firstName:
          type:
            - string
            - "null"
          description: The contact's first name.
          examples:
            - Alex
        lastName:
          type:
            - string
            - "null"
          description: The contact's last name.
          examples:
            - Rivera
        source:
          type: string
          description: The source the contact was created from.
          examples:
            - API
        subscribed:
          type: boolean
          description: Whether the contact will receive campaign and workflow emails.
          examples:
            - true
        userGroup:
          type: string
          description: The contact's user group.
          examples:
            - customers
        userId:
          type:
            - string
            - "null"
          description: The contact's unique user ID.
          examples:
            - usr_7f8e9d0c1b2a
        mailingLists:
          type: object
          description: Mailing lists the contact is subscribed to, represented by
            key-value pairs of mailing list IDs and `true`.
          examples:
            - cm06f5v0e45nf0ml5754o9cix: true
        optInStatus:
          type:
            - string
            - "null"
          description: Double opt-in status. This will be `null` for contacts unless they
            are created via a form while double opt-in is enabled.
          enum:
            - accepted
            - pending
            - rejected
            - null
          examples:
            - accepted
      examples:
        - id: clh3k9m2p4q6r8s0t2v4x6z8
          email: alex@company.com
          firstName: Alex
          lastName: Rivera
          source: API
          subscribed: true
          userGroup: customers
          userId: usr_7f8e9d0c1b2a
          mailingLists:
            clm2k8j4h6g0f8d6s4a2b0z8: true
          optInStatus: accepted
    ContactFields:
      type: object
      properties:
        email:
          type: string
          examples:
            - alex@company.com
          description: The contact's email address.
        firstName:
          type: string
          description: The contact's first name.
          examples:
            - Alex
        lastName:
          type: string
          description: The contact's last name.
          examples:
            - Rivera
        source:
          type: string
          description: A custom source value to replace the default “API”.
          examples:
            - API
        subscribed:
          type: boolean
          description: Whether the contact will receive campaign and workflow emails. All
            new contacts are subscribed by default.
        userGroup:
          type: string
          description: The contact's user group.
          examples:
            - customers
        userId:
          type: string
          description: A unique user ID (for example, from an external application).
          examples:
            - usr_7f8e9d0c1b2a
        mailingLists:
          $ref: "#/components/schemas/MailingListSubscriptions"
      additionalProperties:
        oneOf:
          - title: String
            type: string
          - title: Number
            type: number
          - title: Boolean
            type: boolean
      examples:
        - email: alex@company.com
          firstName: Alex
          lastName: Rivera
          subscribed: true
          userGroup: customers
          userId: usr_7f8e9d0c1b2a
          mailingLists:
            clm2k8j4h6g0f8d6s4a2b0z8: true
          favoriteColor: blue
    ContactRequest:
      allOf:
        - $ref: "#/components/schemas/ContactFields"
        - type: object
          required:
            - email
    ContactUpdateRequest:
      allOf:
        - $ref: "#/components/schemas/ContactFields"
        - type: object
          properties:
            email:
              type: string
              description: The contact's email address. **Required if `userId` is not
                provided.**
            subscribed:
              type: boolean
              description: Whether the contact will receive campaign and workflow emails. We
                recommend leaving this field out of your update requests unless
                you specifically want to unsubscribe (`false`) or re-subscribe
                (`true`) a contact. All new contacts are subscribed by default.
            userId:
              type: string
              description: The contact's unique user ID. **Required if `email` is not
                provided.**
          anyOf:
            - title: Identify by email
              required:
                - email
            - title: Identify by user ID
              required:
                - userId
      additionalProperties:
        oneOf:
          - title: String
            type: string
          - title: Number
            type: number
          - title: Boolean
            type: boolean
      examples:
        - email: alex@company.com
          firstName: Alex
          lastName: Rivera
          subscribed: true
          userGroup: customers
          userId: usr_7f8e9d0c1b2a
          mailingLists:
            clm2k8j4h6g0f8d6s4a2b0z8: true
          favoriteColor: blue
    ContactSuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - true
        id:
          type: string
          examples:
            - clh3k9m2p4q6r8s0t2v4x6z8
      required:
        - success
        - id
      examples:
        - success: true
          id: clh3k9m2p4q6r8s0t2v4x6z8
    ContactFailureResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
          examples:
            - Invalid email address.
      required:
        - success
        - message
      examples:
        - success: false
          message: Invalid email address.
    ContactDeleteRequest:
      type: object
      properties:
        email:
          type: string
          description: The contact's email address. Provide this or `userId`, not both.
          examples:
            - alex@company.com
        userId:
          type: string
          description: The contact's unique user ID. Provide this or `email`, not both.
          examples:
            - usr_7f8e9d0c1b2a
      oneOf:
        - title: Identify by email
          required:
            - email
        - title: Identify by user ID
          required:
            - userId
      examples:
        - email: alex@company.com
        - userId: usr_7f8e9d0c1b2a
    ContactDeleteResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - true
        message:
          type: string
          examples:
            - Contact deleted.
      required:
        - success
        - message
    ContactSuppressionStatusResponse:
      type: object
      properties:
        contact:
          type: object
          properties:
            id:
              type: string
              description: The contact's Loops ID.
            email:
              type: string
              description: The contact's email address.
            userId:
              type:
                - string
                - "null"
              description: The contact's unique user ID.
          required:
            - id
            - email
            - userId
        isSuppressed:
          type: boolean
          description: Whether the contact is suppressed.
        removalQuota:
          $ref: "#/components/schemas/ContactSuppressionRemovalQuota"
          description: The removal quota for the contact.
      required:
        - contact
        - isSuppressed
        - removalQuota
      examples:
        - contact:
            id: clh3k9m2p4q6r8s0t2v4x6z8
            email: alex@company.com
            userId: usr_7f8e9d0c1b2a
          isSuppressed: false
          removalQuota:
            limit: 5
            remaining: 5
    ContactSuppressionRemoveResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the suppression removal was successful.
          examples:
            - true
        message:
          type: string
          examples:
            - Email removed from suppression list.
        removalQuota:
          $ref: "#/components/schemas/ContactSuppressionRemovalQuota"
      required:
        - success
        - message
        - removalQuota
    ContactSuppressionRemovalQuota:
      type: object
      properties:
        limit:
          type: number
          description: The number of suppression removals allowed in a rolling 30 day
            period.
          examples:
            - 100
        remaining:
          type: number
          description: The remaining number of suppression removals left in the current 30
            day period.
          examples:
            - 10
      required:
        - limit
        - remaining
    ContactPropertyCreateRequest:
      type: object
      required:
        - name
        - type
      description: There are a few [reserved
        names](https://loops.so/docs/contacts/properties#reserved-names) that
        you cannot use for contact properties.
      properties:
        name:
          type: string
          examples:
            - favoriteColor
          description: The name of the property. This should be in camelCase, like
            `planName` or `importDate`.
        type:
          type: string
          examples:
            - string
          description: The type of property.
          enum:
            - string
            - number
            - boolean
            - date
      examples:
        - name: favoriteColor
          type: string
    ContactPropertySuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - true
      required:
        - success
    ContactPropertyFailureResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
          examples:
            - Property already exists.
      required:
        - success
        - message
      examples:
        - success: false
          message: Property already exists.
    EventRequest:
      type: object
      required:
        - eventName
      anyOf:
        - title: Identify by email
          required:
            - email
        - title: Identify by user ID
          required:
            - userId
      properties:
        email:
          type: string
          description: The contact's email address. **Required if `userId` is not
            provided.**
          examples:
            - alex@company.com
        userId:
          type: string
          description: The contact's unique user ID. **Required if `email` is not
            provided.**
          examples:
            - usr_7f8e9d0c1b2a
        eventName:
          type: string
          description: The name of the event.
          examples:
            - signup
        eventProperties:
          type: object
          description: An object containing event property data for the event, available
            in emails sent by the event.
          examples:
            - planName: Pro
              importDate: 2021-01-01
        mailingLists:
          $ref: "#/components/schemas/MailingListSubscriptions"
      additionalProperties:
        oneOf:
          - title: String
            type: string
          - title: Number
            type: number
          - title: Boolean
            type: boolean
      examples:
        - email: alex@company.com
          userId: usr_7f8e9d0c1b2a
          eventName: signup
          eventProperties:
            plan: pro
          mailingLists:
            clm2k8j4h6g0f8d6s4a2b0z8: true
          favoriteColor: blue
          planName: Pro
    EventSuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - true
      required:
        - success
    EventFailureResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
          examples:
            - Contact not found.
      required:
        - success
        - message
      examples:
        - success: false
          message: Contact not found.
    TransactionalRequest:
      type: object
      required:
        - email
        - transactionalId
      properties:
        email:
          type: string
          examples:
            - alex@company.com
          description: The recipient's email address.
        transactionalId:
          type: string
          description: The ID of the transactional email to send.
          examples:
            - cll42l54f20i1la0lfooe3z12
        addToAudience:
          type: boolean
          description: If `true`, a contact will be created in your audience using the
            `email` value (if a matching contact doesn't already exist).
          examples:
            - true
        dataVariables:
          type: object
          description: >-
            An object containing data as defined by the data variables added to
            the transactional email template. Values can be of type string or
            number.


            If you have added optional data variables to your email, you can
            exclude them from the dataVariables object or set the value to "".


            If you have added an array data variable to your email, make sure to
            include an array matching the data variables you added to your array
            block.
          examples:
            - name: Chris
              passwordResetLink: https://example.com/reset-password
        attachments:
          type: array
          description: A list containing file objects to be sent along with an email
            message. Attachments must be enabled by Loops support before they
            can be used with the API.
          items:
            type: object
            required:
              - filename
              - contentType
              - data
            properties:
              filename:
                type: string
                description: The name of the file, shown in email clients.
              contentType:
                type: string
                description: The MIME type of the file.
              data:
                type: string
                description: The base64-encoded content of the file.
      examples:
        - email: alex@company.com
          transactionalId: cll42l54f20i1la0lfooe3z12
          addToAudience: true
          dataVariables:
            name: Alex
            passwordResetLink: https://app.company.com/reset/abc123
    TransactionalSuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - true
      required:
        - success
    TransactionalFailureResponse:
      type: object
      properties:
        message:
          type: string
          examples:
            - Transactional email not found.
      required:
        - message
      examples:
        - message: Transactional email not found.
    TransactionalSendFailureResponse:
      title: General error
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
          examples:
            - "Missing required data variable(s): confirmationUrl"
      required:
        - success
        - message
      examples:
        - success: false
          message: "Missing required data variable(s): confirmationUrl"
    TransactionalFailure2Response:
      title: Attachments not enabled
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
        path:
          type: string
      required:
        - success
        - message
        - path
    TransactionalFailure3Response:
      title: Invalid request or email
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
        error:
          type: object
          properties:
            path:
              type: string
            message:
              type: string
      required:
        - success
        - message
        - error
    TransactionalFailure4Response:
      title: Email not sendable
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
        error:
          type: object
          properties:
            path:
              type: string
            reason:
              type: string
      required:
        - success
        - message
        - error
    TransactionalFailure5Response:
      title: Invalid data variables
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
        error:
          type: object
          properties:
            path:
              type: string
            message:
              type: string
        transactionalId:
          type: string
          examples:
            - cll42l54f20i1la0lfooe3z12
      required:
        - success
        - message
        - error
        - transactionalId
      examples:
        - success: false
          message: "Missing required data variable(s): confirmationUrl"
          error:
            path: dataVariables
            message: "Missing required data variable(s): confirmationUrl"
          transactionalId: cll42l54f20i1la0lfooe3z12
    IdempotencyKeyFailureResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - false
        message:
          type: string
      required:
        - success
        - message
      examples:
        - success: false
          message: Request with idempotency key <idempotencyKey> has already been
            processed.
    TransactionalEmail:
      type: object
      properties:
        id:
          type: string
          description: The ID of the transactional email.
        name:
          type: string
          description: The name of the transactional email.
        lastUpdated:
          type: string
          description: The date and time the transactional email was last updated in ISO
            8601 format.
        dataVariables:
          type: array
          description: The data variables used by the transactional email.
      examples:
        - id: cll42l54f20i1la0lfooe3z12
          name: Sign up confirmation
          lastUpdated: 2025-02-02T02:56:28.845Z
          dataVariables:
            - confirmationUrl
      required:
        - id
        - name
        - lastUpdated
        - dataVariables
    ListTransactionalsResponse:
      type: object
      properties:
        pagination:
          $ref: "#/components/schemas/Pagination"
        data:
          type: array
          items:
            $ref: "#/components/schemas/TransactionalEmail"
      examples:
        - pagination:
            totalResults: 2
            returnedResults: 2
            perPage: 20
            totalPages: 1
            nextCursor: null
            nextPage: null
          data:
            - id: cll42l54f20i1la0lfooe3z12
              name: Sign up confirmation
              lastUpdated: 2025-06-29T07:47:39.370Z
              dataVariables:
                - confirmationUrl
    TransactionalResource:
      type: object
      properties:
        id:
          type: string
          description: The ID of the transactional email.
          examples:
            - cll42l54f20i1la0lfooe3z12
        url:
          type: string
          format: uri
          description: The URL of the transactional email in the Loops app.
          examples:
            - https://app.loops.so/transactional/cll42l54f20i1la0lfooe3z12
        name:
          type: string
          description: The name of the transactional email.
          examples:
            - Sign up confirmation
        draftEmailMessageId:
          type:
            - string
            - "null"
          description: The ID of the draft email message. `null` if there is no draft
            version.
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
        publishedEmailMessageId:
          type:
            - string
            - "null"
          description: The ID of the published email message. `null` if there is no
            published version.
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
        transactionalGroupId:
          type:
            - string
            - "null"
          description: The ID of the group this transactional email belongs to.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
        createdAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp for when the transactional email was created.
          examples:
            - 2025-06-29T07:47:39.370Z
        updatedAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp for when the transactional email was last updated.
          examples:
            - 2025-06-29T07:47:39.370Z
        dataVariables:
          type: array
          description: Data variable names used by the published email. Empty for
            unpublished transactional emails.
          items:
            type: string
      required:
        - id
        - url
        - name
        - draftEmailMessageId
        - publishedEmailMessageId
        - transactionalGroupId
        - createdAt
        - updatedAt
        - dataVariables
      examples:
        - id: cll42l54f20i1la0lfooe3z12
          url: https://app.loops.so/transactional/cll42l54f20i1la0lfooe3z12
          name: Sign up confirmation
          draftEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          publishedEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          transactionalGroupId: clg7n5p3q1r9s7t5u3v1w9y7
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
          dataVariables:
            - confirmationUrl
    TransactionalDraftResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the transactional email.
        url:
          type: string
          format: uri
          description: The URL of the transactional email in the Loops app.
          examples:
            - https://app.loops.so/transactional/cll42l54f20i1la0lfooe3z12
        name:
          type: string
          description: The name of the transactional email.
        draftEmailMessageId:
          type:
            - string
            - "null"
          description: The ID of the draft email message.
        draftEmailMessageContentRevisionId:
          type:
            - string
            - "null"
          description: The `contentRevisionId` of the draft email message. Pass this as
            `expectedRevisionId` on your first update via `POST
            /v1/email-messages/{emailMessageId}`.
          examples:
            - clrev1s10n2i3d4e5f6g7h8
        publishedEmailMessageId:
          type:
            - string
            - "null"
          description: The ID of the published email message. `null` if there is no
            published version.
        transactionalGroupId:
          type:
            - string
            - "null"
          description: The ID of the group this transactional email belongs to. Returned
            when creating a transactional email.
        createdAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp for when the transactional email was created.
        updatedAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp for when the transactional email was last updated.
        dataVariables:
          type: array
          description: Data variable names used by the published email. Empty for
            unpublished transactional emails.
          items:
            type: string
      required:
        - id
        - url
        - name
        - draftEmailMessageId
        - draftEmailMessageContentRevisionId
        - publishedEmailMessageId
        - createdAt
        - updatedAt
        - dataVariables
      examples:
        - id: cll42l54f20i1la0lfooe3z12
          url: https://app.loops.so/transactional/cll42l54f20i1la0lfooe3z12
          name: Sign up confirmation
          draftEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          publishedEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          transactionalGroupId: clg7n5p3q1r9s7t5u3v1w9y7
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
          dataVariables:
            - confirmationUrl
          draftEmailMessageContentRevisionId: clrev1s10n2i3d4e5f6g7h8
    ListTransactionalsResourceResponse:
      type: object
      properties:
        pagination:
          $ref: "#/components/schemas/Pagination"
        data:
          type: array
          items:
            $ref: "#/components/schemas/TransactionalResource"
      required:
        - pagination
        - data
      examples:
        - pagination:
            totalResults: 2
            returnedResults: 2
            perPage: 20
            totalPages: 1
            nextCursor: null
            nextPage: null
          data:
            - id: cll42l54f20i1la0lfooe3z12
              url: https://app.loops.so/transactional/cll42l54f20i1la0lfooe3z12
              name: Sign up confirmation
              draftEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
              publishedEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
              transactionalGroupId: clg7n5p3q1r9s7t5u3v1w9y7
              createdAt: 2025-06-29T07:47:39.370Z
              updatedAt: 2025-06-29T07:47:39.370Z
              dataVariables:
                - confirmationUrl
    CreateTransactionalRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the transactional email.
          examples:
            - Welcome email
        transactionalGroupId:
          type: string
          description: The ID of the group to add this transactional email to. Defaults to
            the team's Unsorted group when omitted.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
      required:
        - name
      additionalProperties: false
    UpdateTransactionalRequest:
      type: object
      minProperties: 1
      description: At least one field must be provided.
      properties:
        name:
          type: string
          examples:
            - Password reset email
        transactionalGroupId:
          type: string
          description: The ID of the group to move this transactional email to.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
      additionalProperties: false
    ContactProperty:
      type: object
      properties:
        key:
          type: string
          description: The key of the contact property.
        label:
          type: string
          description: The human-friendly label for this property.
        type:
          type: string
          description: The type of property.
          enum:
            - string
            - number
            - boolean
            - date
      examples:
        - key: favoriteColor
          label: Favorite color
          type: string
      required:
        - key
        - label
        - type
    MailingList:
      type: object
      properties:
        id:
          type: string
          description: The ID of the mailing list.
          examples:
            - clm2k8j4h6g0f8d6s4a2b0z8
        name:
          type: string
          description: The name of the mailing list.
          examples:
            - Product updates
        description:
          type:
            - string
            - "null"
          description: The description of the mailing list. `null` if no description is set.
          examples:
            - Monthly product news and release notes
        isPublic:
          type: boolean
          description: Whether the mailing list is public (`true`) or private (`false`).
          examples:
            - true
      examples:
        - id: clm2k8j4h6g0f8d6s4a2b0z8
          name: Product updates
          description: Monthly product news and release notes
          isPublic: true
        - id: clm2k8j4h6g0f8d6s4a2b0z8
          name: Product updates
          description: null
          isPublic: true
      required:
        - id
        - name
        - description
        - isPublic
    MailingListSubscriptions:
      type: object
      description: >-
        Manage mailing list subscriptions.


        Include key-value pairs of mailing list IDs and a `boolean` denoting if
        the contact should be added (`true`) or removed (`false`) from the list.
      examples:
        - cm06f5v0e45nf0ml5754o9cix: true
          cm16k73gq014h0mmj5b6jdi9r: false
    Theme:
      type: object
      properties:
        id:
          type: string
          description: The ID of the theme.
          examples:
            - clt3u5v7w9x1y3z5a7b9c1d3
        name:
          type: string
          description: The name of the theme.
          examples:
            - Default
        styles:
          $ref: "#/components/schemas/ThemeStyles"
        isDefault:
          type: boolean
          description: Whether this theme is the team's default.
          examples:
            - true
        createdAt:
          type: string
          description: ISO 8601 timestamp for when the theme was created.
          examples:
            - 2025-06-29T07:47:39.370Z
        updatedAt:
          type: string
          description: ISO 8601 timestamp for when the theme was last updated.
          examples:
            - 2025-06-29T07:47:39.370Z
      required:
        - id
        - name
        - styles
        - isDefault
        - createdAt
        - updatedAt
      examples:
        - id: clt3u5v7w9x1y3z5a7b9c1d3
          name: Default
          styles:
            backgroundColor: "#f5f5f5"
            backgroundXPadding: 24
            backgroundYPadding: 24
            bodyColor: "#ffffff"
            bodyXPadding: 24
            bodyYPadding: 24
            bodyFontFamily: Helvetica
            bodyFontCategory: sans-serif
            borderColor: "#e5e5e5"
            borderWidth: 1
            borderRadius: 8
            buttonBodyColor: "#111827"
            buttonBodyXPadding: 16
            buttonBodyYPadding: 12
            buttonBorderColor: "#111827"
            buttonBorderWidth: 0
            buttonBorderRadius: 6
            buttonTextColor: "#ffffff"
            buttonTextFormat: 0
            buttonTextFontSize: 16
            dividerColor: "#e5e5e5"
            dividerBorderWidth: 1
            textBaseColor: "#374151"
            textBaseFontSize: 16
            textBaseLineHeight: 24
            textBaseLetterSpacing: 0
            textLinkColor: "#2563eb"
            heading1Color: "#111827"
            heading1FontSize: 28
            heading1LineHeight: 36
            heading1LetterSpacing: -0.5
            heading2Color: "#111827"
            heading2FontSize: 22
            heading2LineHeight: 30
            heading2LetterSpacing: -0.25
            heading3Color: "#111827"
            heading3FontSize: 18
            heading3LineHeight: 26
            heading3LetterSpacing: 0
          isDefault: true
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
    ThemeStyles:
      type: object
      description: Flat map of style attributes, matching the attribute names accepted
        by the LMX `<Style />` tag.
      properties:
        backgroundColor:
          type: string
        backgroundXPadding:
          type: number
        backgroundYPadding:
          type: number
        bodyColor:
          type: string
        bodyXPadding:
          type: number
        bodyYPadding:
          type: number
        bodyFontFamily:
          type: string
        bodyFontCategory:
          type: string
        borderColor:
          type: string
        borderWidth:
          type: number
        borderRadius:
          type: number
        buttonBodyColor:
          type: string
        buttonBodyXPadding:
          type: number
        buttonBodyYPadding:
          type: number
        buttonBorderColor:
          type: string
        buttonBorderWidth:
          type: number
        buttonBorderRadius:
          type: number
        buttonTextColor:
          type: string
        buttonTextFormat:
          type: number
        buttonTextFontSize:
          type: number
        dividerColor:
          type: string
        dividerBorderWidth:
          type: number
        textBaseColor:
          type: string
        textBaseFontSize:
          type: number
        textBaseLineHeight:
          type: number
        textBaseLetterSpacing:
          type: number
        textLinkColor:
          type: string
        heading1Color:
          type: string
        heading1FontSize:
          type: number
        heading1LineHeight:
          type: number
        heading1LetterSpacing:
          type: number
        heading2Color:
          type: string
        heading2FontSize:
          type: number
        heading2LineHeight:
          type: number
        heading2LetterSpacing:
          type: number
        heading3Color:
          type: string
        heading3FontSize:
          type: number
        heading3LineHeight:
          type: number
        heading3LetterSpacing:
          type: number
    ListThemesResponse:
      type: object
      properties:
        pagination:
          $ref: "#/components/schemas/Pagination"
        data:
          type: array
          items:
            $ref: "#/components/schemas/Theme"
      required:
        - pagination
        - data
      examples:
        - pagination:
            totalResults: 2
            returnedResults: 2
            perPage: 20
            totalPages: 1
            nextCursor: null
            nextPage: null
          data:
            - id: clt3u5v7w9x1y3z5a7b9c1d3
              name: Default
              styles:
                backgroundColor: "#f5f5f5"
                backgroundXPadding: 24
                backgroundYPadding: 24
                bodyColor: "#ffffff"
                bodyXPadding: 24
                bodyYPadding: 24
                bodyFontFamily: Helvetica
                bodyFontCategory: sans-serif
                borderColor: "#e5e5e5"
                borderWidth: 1
                borderRadius: 8
                buttonBodyColor: "#111827"
                buttonBodyXPadding: 16
                buttonBodyYPadding: 12
                buttonBorderColor: "#111827"
                buttonBorderWidth: 0
                buttonBorderRadius: 6
                buttonTextColor: "#ffffff"
                buttonTextFormat: 0
                buttonTextFontSize: 16
                dividerColor: "#e5e5e5"
                dividerBorderWidth: 1
                textBaseColor: "#374151"
                textBaseFontSize: 16
                textBaseLineHeight: 24
                textBaseLetterSpacing: 0
                textLinkColor: "#2563eb"
                heading1Color: "#111827"
                heading1FontSize: 28
                heading1LineHeight: 36
                heading1LetterSpacing: -0.5
                heading2Color: "#111827"
                heading2FontSize: 22
                heading2LineHeight: 30
                heading2LetterSpacing: -0.25
                heading3Color: "#111827"
                heading3FontSize: 18
                heading3LineHeight: 26
                heading3LetterSpacing: 0
              isDefault: true
              createdAt: 2025-06-29T07:47:39.370Z
              updatedAt: 2025-06-29T07:47:39.370Z
    ThemeResponse:
      type: object
      properties:
        id:
          type: string
          examples:
            - clt3u5v7w9x1y3z5a7b9c1d3
          description: The ID of the theme.
        name:
          type: string
          examples:
            - Default
          description: The name of the theme.
        styles:
          $ref: "#/components/schemas/ThemeStyles"
        isDefault:
          type: boolean
          description: Whether this theme is the team's default.
          examples:
            - true
        createdAt:
          type: string
          description: ISO 8601 timestamp for when the theme was created.
          examples:
            - 2025-06-29T07:47:39.370Z
        updatedAt:
          type: string
          description: ISO 8601 timestamp for when the theme was last updated.
          examples:
            - 2025-06-29T07:47:39.370Z
      required:
        - id
        - name
        - styles
        - isDefault
        - createdAt
        - updatedAt
      examples:
        - id: clt3u5v7w9x1y3z5a7b9c1d3
          name: Default
          styles:
            backgroundColor: "#f5f5f5"
            backgroundXPadding: 24
            backgroundYPadding: 24
            bodyColor: "#ffffff"
            bodyXPadding: 24
            bodyYPadding: 24
            bodyFontFamily: Helvetica
            bodyFontCategory: sans-serif
            borderColor: "#e5e5e5"
            borderWidth: 1
            borderRadius: 8
            buttonBodyColor: "#111827"
            buttonBodyXPadding: 16
            buttonBodyYPadding: 12
            buttonBorderColor: "#111827"
            buttonBorderWidth: 0
            buttonBorderRadius: 6
            buttonTextColor: "#ffffff"
            buttonTextFormat: 0
            buttonTextFontSize: 16
            dividerColor: "#e5e5e5"
            dividerBorderWidth: 1
            textBaseColor: "#374151"
            textBaseFontSize: 16
            textBaseLineHeight: 24
            textBaseLetterSpacing: 0
            textLinkColor: "#2563eb"
            heading1Color: "#111827"
            heading1FontSize: 28
            heading1LineHeight: 36
            heading1LetterSpacing: -0.5
            heading2Color: "#111827"
            heading2FontSize: 22
            heading2LineHeight: 30
            heading2LetterSpacing: -0.25
            heading3Color: "#111827"
            heading3FontSize: 18
            heading3LineHeight: 26
            heading3LetterSpacing: 0
          isDefault: true
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
    ThemeFailureResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      examples:
        - message: Theme not found.
    CreateThemeBody:
      type: object
      properties:
        name:
          type: string
          description: The theme name.
          examples:
            - Dark mode
        styles:
          description: Style attributes for the theme. Attributes use the same names as
            the LMX [`<Style />`](/creating-emails/lmx#document-styles) tag
            attributes.
          $ref: "#/components/schemas/ThemeStyles"
      required:
        - name
      examples:
        - name: Dark mode
          styles:
            backgroundColor: "#111827"
            bodyColor: "#1f2937"
    UpdateThemeBody:
      type: object
      description: At least one of `name` or `styles` must be provided.
      properties:
        name:
          type: string
        styles:
          $ref: "#/components/schemas/ThemeStyles"
    UpdateThemeResponse:
      allOf:
        - $ref: "#/components/schemas/ThemeResponse"
        - type: object
          properties:
            affectedEmailCount:
              type: number
              description: The number of emails using this theme that are affected by the
                style change. `0` when only the name changed.
          required:
            - affectedEmailCount
      examples:
        - id: clt3u5v7w9x1y3z5a7b9c1d3
          name: Default
          styles:
            backgroundColor: "#f5f5f5"
            backgroundXPadding: 24
            backgroundYPadding: 24
            bodyColor: "#ffffff"
            bodyXPadding: 24
            bodyYPadding: 24
            bodyFontFamily: Helvetica
            bodyFontCategory: sans-serif
            borderColor: "#e5e5e5"
            borderWidth: 1
            borderRadius: 8
            buttonBodyColor: "#111827"
            buttonBodyXPadding: 16
            buttonBodyYPadding: 12
            buttonBorderColor: "#111827"
            buttonBorderWidth: 0
            buttonBorderRadius: 6
            buttonTextColor: "#ffffff"
            buttonTextFormat: 0
            buttonTextFontSize: 16
            dividerColor: "#e5e5e5"
            dividerBorderWidth: 1
            textBaseColor: "#374151"
            textBaseFontSize: 16
            textBaseLineHeight: 24
            textBaseLetterSpacing: 0
            textLinkColor: "#2563eb"
            heading1Color: "#111827"
            heading1FontSize: 28
            heading1LineHeight: 36
            heading1LetterSpacing: -0.5
            heading2Color: "#111827"
            heading2FontSize: 22
            heading2LineHeight: 30
            heading2LetterSpacing: -0.25
            heading3Color: "#111827"
            heading3FontSize: 18
            heading3LineHeight: 26
            heading3LetterSpacing: 0
          isDefault: true
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
          affectedEmailCount: 12
    Component:
      type: object
      properties:
        id:
          type: string
          examples:
            - clp2o4i6u8y0t5r3e1w7q9s1
        name:
          type: string
          examples:
            - Header
        lmx:
          type: string
          description: The component body serialized as LMX.
          examples:
            - <Paragraph>Welcome to Acme</Paragraph>
      required:
        - id
        - name
        - lmx
      examples:
        - id: clp2o4i6u8y0t5r3e1w7q9s1
          name: Header
          lmx: <Paragraph>Welcome to Acme</Paragraph>
    ListComponentsResponse:
      type: object
      properties:
        pagination:
          $ref: "#/components/schemas/Pagination"
        data:
          type: array
          items:
            $ref: "#/components/schemas/Component"
      required:
        - pagination
        - data
      examples:
        - pagination:
            totalResults: 2
            returnedResults: 2
            perPage: 20
            totalPages: 1
            nextCursor: null
            nextPage: null
          data:
            - id: clp2o4i6u8y0t5r3e1w7q9s1
              name: Header
              lmx: <Paragraph>Welcome to Acme</Paragraph>
    ComponentResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the component.
        name:
          type: string
          description: The name of the component.
        lmx:
          type: string
          description: The component body serialized as LMX.
      required:
        - id
        - name
        - lmx
      examples:
        - id: clp2o4i6u8y0t5r3e1w7q9s1
          name: Header
          lmx: <Paragraph>Welcome to Acme</Paragraph>
    ComponentFailureResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      examples:
        - message: Component not found.
    ComponentValidationFailureResponse:
      type: object
      properties:
        message:
          type: string
        invalidTags:
          type: array
          description: The dynamic variables that the change would push into an email that
            cannot use them. Present only when the update was rejected for that
            reason.
          items:
            type: string
      required:
        - message
      examples:
        - message: Component uses unsupported contact properties.
          invalidTags:
            - companyName
    CreateComponentBody:
      type: object
      properties:
        name:
          type: string
          description: The component name.
        lmx:
          type: string
          description: The component body as an LMX string.
      required:
        - name
        - lmx
      examples:
        - name: Header
          lmx: <Paragraph>Welcome to Acme</Paragraph>
    UpdateComponentBody:
      type: object
      description: At least one of `name` or `lmx` must be provided.
      properties:
        name:
          type: string
        lmx:
          type: string
          description: The component body as an LMX string.
    UpdateComponentResponse:
      allOf:
        - $ref: "#/components/schemas/ComponentResponse"
        - type: object
          properties:
            affectedEmailCount:
              type: number
              description: The number of emails using this component that were updated by the
                body change. `0` when only the name changed.
          required:
            - affectedEmailCount
      examples:
        - id: clp2o4i6u8y0t5r3e1w7q9s1
          name: Header
          lmx: <Paragraph>Welcome to Acme</Paragraph>
          affectedEmailCount: 3
    AudienceSegment:
      type: object
      properties:
        id:
          type: string
          description: The ID of the audience segment.
          examples:
            - cls6e8g0i2k4m6o8q0s2u4w6
        name:
          type: string
          description: The name of the audience segment.
          examples:
            - Power users
        description:
          type:
            - string
            - "null"
          description: An optional description of the audience segment.
          examples:
            - Contacts on the pro plan
        createdAt:
          type: string
          description: ISO 8601 timestamp for when the audience segment was created.
          examples:
            - 2025-06-29T07:47:39.370Z
        updatedAt:
          type: string
          description: ISO 8601 timestamp for when the audience segment was last updated.
          examples:
            - 2025-06-29T07:47:39.370Z
        filter:
          $ref: "#/components/schemas/AudienceFilter"
      required:
        - id
        - name
        - description
        - createdAt
        - updatedAt
        - filter
      examples:
        - id: cls6e8g0i2k4m6o8q0s2u4w6
          name: Power users
          description: Contacts on the pro plan
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
          filter:
            match: all
            conditions:
              - type: property
                key: plan
                operator: equals
                value: pro
    ListAudienceSegmentsResponse:
      type: object
      properties:
        pagination:
          $ref: "#/components/schemas/Pagination"
        data:
          type: array
          items:
            $ref: "#/components/schemas/AudienceSegment"
      required:
        - pagination
        - data
      examples:
        - pagination:
            totalResults: 2
            returnedResults: 2
            perPage: 20
            totalPages: 1
            nextCursor: null
            nextPage: null
          data:
            - id: cls6e8g0i2k4m6o8q0s2u4w6
              name: Power users
              description: Contacts on the pro plan
              createdAt: 2025-06-29T07:47:39.370Z
              updatedAt: 2025-06-29T07:47:39.370Z
              filter:
                match: all
                conditions:
                  - type: property
                    key: plan
                    operator: equals
                    value: pro
    AudienceSegmentResponse:
      $ref: "#/components/schemas/AudienceSegment"
      examples:
        - id: cls6e8g0i2k4m6o8q0s2u4w6
          name: Power users
          description: Contacts on the pro plan
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
          filter:
            match: all
            conditions:
              - type: property
                key: plan
                operator: equals
                value: pro
    CreateAudienceSegmentRequest:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
          description: The name of the audience segment. Must be unique within the team.
          examples:
            - Active users
        description:
          type: string
          maxLength: 1000
          description: An optional description of the audience segment.
        filter:
          type: object
          description: A tree of audience conditions combined with `match`.
          properties:
            match:
              type: string
              enum:
                - all
                - any
            conditions:
              type: array
              minItems: 1
              items:
                $ref: "#/components/schemas/AudienceFilterCondition"
          required:
            - match
            - conditions
          additionalProperties: false
      required:
        - name
        - filter
      additionalProperties: false
    AudienceSegmentFailureResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      examples:
        - message: Audience segment not found.
    CampaignScheduling:
      type: object
      description: When the campaign is scheduled to send.
      properties:
        method:
          type: string
          enum:
            - now
            - schedule
        timestamp:
          type:
            - string
            - "null"
          format: date-time
          description: ISO 8601 send time. Null when the method is `now`.
      required:
        - method
        - timestamp
      examples:
        - method: schedule
          timestamp: 2025-07-15T14:00:00.000Z
    CampaignSchedulingRequest:
      type: object
      description: When the campaign should send. `timestamp` is required and must be
        in the future when `method` is `schedule`, and must be omitted when
        `method` is `now`.
      properties:
        method:
          type: string
          enum:
            - now
            - schedule
        timestamp:
          type: string
          format: date-time
      required:
        - method
      additionalProperties: false
      examples:
        - method: schedule
          timestamp: 2025-07-15T14:00:00.000Z
    AudienceFilter:
      type:
        - object
        - "null"
      description: A tree of audience conditions combined with `match`.
      properties:
        match:
          type: string
          enum:
            - all
            - any
        conditions:
          type: array
          minItems: 1
          items:
            $ref: "#/components/schemas/AudienceFilterCondition"
      required:
        - match
        - conditions
      additionalProperties: false
    AudienceFilterInRequest:
      type:
        - object
        - "null"
      description: A tree of audience conditions combined with `match`. Setting this
        without also providing `audienceSegmentId` clears any existing
        `audienceSegmentId`. When both are provided, this filter is applied on
        top of the segment's filter.
      properties:
        match:
          type: string
          enum:
            - all
            - any
        conditions:
          type: array
          minItems: 1
          items:
            $ref: "#/components/schemas/AudienceFilterCondition"
      required:
        - match
        - conditions
      additionalProperties: false
    AudienceFilterCondition:
      oneOf:
        - $ref: "#/components/schemas/PropertyCondition"
        - $ref: "#/components/schemas/OptInCondition"
        - $ref: "#/components/schemas/ActivityCondition"
      discriminator:
        propertyName: type
    PropertyCondition:
      title: Contact property
      type: object
      description: Matches contacts by a property value.
      properties:
        type:
          type: string
          enum:
            - property
        key:
          type: string
          description: The contact property name.
        operator:
          type: string
          enum:
            - any
            - contains
            - notContains
            - equals
            - notEquals
            - greaterThan
            - lessThan
            - isTrue
            - isFalse
            - empty
            - notEmpty
            - dateEmpty
            - dateNotEmpty
            - after
            - before
            - between
        value:
          description: The comparison value. Omitted for value-less operators (e.g.
            `isTrue`, `empty`). A `{ from, to }` object for `between`.
          oneOf:
            - title: String
              type: string
            - title: Number
              type: number
            - title: Date range
              type: object
              properties:
                from:
                  type: string
                  format: date-time
                to:
                  type: string
                  format: date-time
              required:
                - from
                - to
      required:
        - type
        - key
        - operator
      examples:
        - type: property
          key: plan
          operator: equals
          value: pro
    OptInCondition:
      title: Mailing list opt-in
      type: object
      description: Matches contacts by mailing list opt-in status.
      properties:
        type:
          type: string
          enum:
            - optIn
        status:
          type:
            - string
            - "null"
          enum:
            - accepted
            - pending
            - rejected
            - null
      required:
        - type
        - status
      examples:
        - type: optIn
          status: accepted
    ActivityCondition:
      title: Activity
      type: object
      description: Matches contacts by their activity on a campaign or workflow.
      properties:
        type:
          type: string
          enum:
            - activity
        action:
          type: string
          enum:
            - sent
            - opened
            - clicked
        negate:
          type: boolean
        target:
          type: string
          enum:
            - campaign
            - workflow
            - workflowEmail
        id:
          type: string
          description: The ID of the campaign, workflow, or workflow email.
      required:
        - type
        - action
        - negate
        - target
        - id
      examples:
        - type: activity
          action: opened
          negate: false
          target: campaign
          id: clc4m6n8p0q2r4s6t8u0v2x4
    CampaignListItem:
      $ref: "#/components/schemas/CampaignResponse"
    ListCampaignsResponse:
      type: object
      properties:
        pagination:
          $ref: "#/components/schemas/Pagination"
        data:
          type: array
          items:
            $ref: "#/components/schemas/CampaignResponse"
      required:
        - pagination
        - data
      examples:
        - pagination:
            totalResults: 45
            returnedResults: 20
            perPage: 20
            totalPages: 3
            nextCursor: clp9k2m4n6p8q0r2s4t6u8v0
            nextPage: https://app.loops.so/api/v1/campaigns?cursor=clp9k2m4n6p8q0r2s4t6u8v0&perPage=20
          data:
            - id: clc4m6n8p0q2r4s6t8u0v2x4
              url: https://app.loops.so/campaigns/clc4m6n8p0q2r4s6t8u0v2x4
              name: Spring announcement
              status: Draft
              createdAt: 2025-06-29T07:47:39.370Z
              updatedAt: 2025-06-29T07:47:39.370Z
              emailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
              campaignGroupId: clg7n5p3q1r9s7t5u3v1w9y7
              mailingListId: clm2k8j4h6g0f8d6s4a2b0z8
              audienceSegmentId: null
              audienceFilter: null
              scheduling:
                method: now
                timestamp: null
    CreateCampaignRequest:
      type: object
      properties:
        name:
          type: string
          description: The campaign name.
          examples:
            - Spring announcement
        campaignGroupId:
          type: string
          description: The ID of the group to add this campaign to. Defaults to the team's
            Unsorted group when omitted.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
        mailingListId:
          type:
            - string
            - "null"
          description: The ID of the mailing list to send to.
          examples:
            - clm2k8j4h6g0f8d6s4a2b0z8
        audienceSegmentId:
          type:
            - string
            - "null"
          description: The ID of an audience segment. Setting this without also providing
            `audienceFilter` clears any existing `audienceFilter`. If both are
            provided, the filter is applied on top of the segment's filter.
          examples:
            - cls6e8g0i2k4m6o8q0s2u4w6
        audienceFilter:
          $ref: "#/components/schemas/AudienceFilterInRequest"
        scheduling:
          $ref: "#/components/schemas/CampaignSchedulingRequest"
      required:
        - name
      additionalProperties: false
    CreateCampaignResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the campaign.
          examples:
            - clc4m6n8p0q2r4s6t8u0v2x4
        url:
          type: string
          format: uri
          description: The URL of the campaign in the Loops app.
          examples:
            - https://app.loops.so/campaigns/clc4m6n8p0q2r4s6t8u0v2x4
        name:
          type: string
          description: The name of the campaign.
          examples:
            - Spring announcement
        status:
          type: string
          examples:
            - Draft
          enum:
            - Draft
          description: The status of the campaign (always `Draft` for new campaigns).
        createdAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
          description: ISO 8601 timestamp for when the campaign was created.
        updatedAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
          description: ISO 8601 timestamp for when the campaign was last updated.
        emailMessageId:
          type:
            - string
            - "null"
          description: The ID of the empty email message created for this campaign. Use
            `POST /v1/email-messages/{emailMessageId}` to set its fields and LMX
            content.
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
        emailMessageContentRevisionId:
          type:
            - string
            - "null"
          description: The `contentRevisionId` of the newly created email message. Pass
            this as `expectedRevisionId` on your first update.
          examples:
            - clrev1s10n2i3d4e5f6g7h8
        campaignGroupId:
          type:
            - string
            - "null"
          description: The ID of the campaign group this campaign belongs to, if set.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
        mailingListId:
          type:
            - string
            - "null"
          description: The ID of the mailing list this campaign sends to, if set.
          examples:
            - clm2k8j4h6g0f8d6s4a2b0z8
        audienceSegmentId:
          type:
            - string
            - "null"
          description: The ID of the audience segment this campaign targets, if set.
          examples:
            - cls6e8g0i2k4m6o8q0s2u4w6
        audienceFilter:
          $ref: "#/components/schemas/AudienceFilter"
          description: The filter rules that define the audience for this campaign, if set.
        scheduling:
          $ref: "#/components/schemas/CampaignScheduling"
          description: When the campaign is scheduled to send.
      required:
        - id
        - url
        - name
        - status
        - createdAt
        - updatedAt
        - emailMessageId
        - emailMessageContentRevisionId
        - campaignGroupId
        - mailingListId
        - audienceSegmentId
        - audienceFilter
        - scheduling
      examples:
        - id: clc4m6n8p0q2r4s6t8u0v2x4
          url: https://app.loops.so/campaigns/clc4m6n8p0q2r4s6t8u0v2x4
          name: Spring announcement
          status: Draft
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
          emailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          campaignGroupId: clg7n5p3q1r9s7t5u3v1w9y7
          mailingListId: clm2k8j4h6g0f8d6s4a2b0z8
          audienceSegmentId: null
          audienceFilter: null
          scheduling:
            method: now
            timestamp: null
          emailMessageContentRevisionId: clrev1s10n2i3d4e5f6g7h8
    UpdateCampaignRequest:
      type: object
      description: At least one field must be provided.
      properties:
        name:
          type: string
          description: The updated campaign name.
          examples:
            - Spring announcement
        campaignGroupId:
          type: string
          description: The ID of the group to move this campaign to.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
        mailingListId:
          type:
            - string
            - "null"
          description: The ID of the mailing list to send to.
          examples:
            - clm2k8j4h6g0f8d6s4a2b0z8
        audienceSegmentId:
          type:
            - string
            - "null"
          description: The ID of an audience segment. Setting this without also providing
            `audienceFilter` clears any existing `audienceFilter`. If both are
            provided, the filter is applied on top of the segment's filter.
          examples:
            - cls6e8g0i2k4m6o8q0s2u4w6
        audienceFilter:
          $ref: "#/components/schemas/AudienceFilterInRequest"
        scheduling:
          $ref: "#/components/schemas/CampaignSchedulingRequest"
      additionalProperties: false
    CampaignResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the campaign.
          examples:
            - clc4m6n8p0q2r4s6t8u0v2x4
        url:
          type: string
          format: uri
          description: The URL of the campaign in the Loops app.
          examples:
            - https://app.loops.so/campaigns/clc4m6n8p0q2r4s6t8u0v2x4
        name:
          type: string
          description: The name of the campaign.
          examples:
            - Spring announcement
        status:
          type: string
          description: The status of the campaign.
          enum:
            - Draft
            - Scheduled
            - Sending
            - Sent
          examples:
            - Draft
        createdAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
          description: ISO 8601 timestamp for when the campaign was created.
        updatedAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
          description: ISO 8601 timestamp for when the campaign was last updated.
        emailMessageId:
          type:
            - string
            - "null"
          description: The associated email message ID.
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
        campaignGroupId:
          type:
            - string
            - "null"
          description: The ID of the campaign group this campaign belongs to.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
        mailingListId:
          type:
            - string
            - "null"
          examples:
            - clm2k8j4h6g0f8d6s4a2b0z8
          description: The ID of the mailing list this campaign sends to, if set.
        audienceSegmentId:
          type:
            - string
            - "null"
          description: The ID of the audience segment this campaign targets, if set.
          examples:
            - cls6e8g0i2k4m6o8q0s2u4w6
        audienceFilter:
          $ref: "#/components/schemas/AudienceFilter"
          description: The filter rules that define the audience for this campaign, if set.
        scheduling:
          $ref: "#/components/schemas/CampaignScheduling"
      required:
        - id
        - url
        - name
        - status
        - createdAt
        - updatedAt
        - emailMessageId
        - campaignGroupId
        - mailingListId
        - audienceSegmentId
        - audienceFilter
        - scheduling
      examples:
        - id: clc4m6n8p0q2r4s6t8u0v2x4
          url: https://app.loops.so/campaigns/clc4m6n8p0q2r4s6t8u0v2x4
          name: Spring announcement
          status: Draft
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
          emailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          campaignGroupId: clg7n5p3q1r9s7t5u3v1w9y7
          mailingListId: clm2k8j4h6g0f8d6s4a2b0z8
          audienceSegmentId: null
          audienceFilter: null
          scheduling:
            method: now
            timestamp: null
    CampaignFailureResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      examples:
        - message: Campaign not found.
    WorkflowSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the workflow.
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        url:
          type: string
          format: uri
          description: The URL of the workflow in the Loops app.
          examples:
            - https://app.loops.so/workflows/clw1a3b5c7d9e1f3g5h7i9j1
        name:
          type: string
          description: The name of the workflow.
          examples:
            - Welcome series
        workflowGroupId:
          type: string
          description: The ID of the workflow group this workflow belongs to.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
        createdAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
          description: ISO 8601 timestamp for when the workflow was created.
        updatedAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
          description: ISO 8601 timestamp for when the workflow was last updated.
      required:
        - id
        - url
        - name
        - workflowGroupId
        - createdAt
        - updatedAt
      examples:
        - id: clw1a3b5c7d9e1f3g5h7i9j1
          url: https://app.loops.so/workflows/clw1a3b5c7d9e1f3g5h7i9j1
          name: Welcome series
          workflowGroupId: clg7n5p3q1r9s7t5u3v1w9y7
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
    ListWorkflowsResponse:
      type: object
      properties:
        pagination:
          $ref: "#/components/schemas/Pagination"
        data:
          type: array
          items:
            $ref: "#/components/schemas/WorkflowSummary"
      required:
        - pagination
        - data
      examples:
        - pagination:
            totalResults: 45
            returnedResults: 20
            perPage: 20
            totalPages: 3
            nextCursor: clp9k2m4n6p8q0r2s4t6u8v0
            nextPage: https://app.loops.so/api/v1/workflows?cursor=clp9k2m4n6p8q0r2s4t6u8v0&perPage=20
          data:
            - id: clw1a3b5c7d9e1f3g5h7i9j1
              url: https://app.loops.so/workflows/clw1a3b5c7d9e1f3g5h7i9j1
              name: Welcome series
              workflowGroupId: clg7n5p3q1r9s7t5u3v1w9y7
              createdAt: 2025-06-29T07:47:39.370Z
              updatedAt: 2025-06-29T07:47:39.370Z
    WorkflowRevisionId:
      type:
        - string
      description: The current workflow revision token. Pass the latest value as
        `expectedRevisionId` on the next workflow mutation.
    NullableWorkflowRevisionId:
      type:
        - string
        - "null"
      description: The current workflow revision token. Pass the latest value as
        `expectedRevisionId` on the next workflow mutation. Will be `null` for
        workflows without a revision token yet.
    WorkflowReEligible:
      type: boolean
      description: If `true`, the contacts will be able to enter this workflow every
        time the trigger is matched. If `false`, contacts will only ever enter
        this workflow once. Matches the "Trigger frequency" option in the UI.
    WorkflowNextNodeIds:
      type: array
      items:
        type: string
      description: The IDs of the nodes that are downstream of this node.
    WorkflowExpectedRevisionId:
      type:
        - string
        - "null"
      description: The workflow revision token returned by the latest workflow read or
        mutation. Older workflows may return `null` before their first
        revision-aware mutation; pass `null` back as `expectedRevisionId` in
        that case. If the token is stale, the API returns a `409 Conflict`
        error.
    WorkflowQueuedContactPolicy:
      type: string
      enum:
        - fail
        - discard
      default: fail
      description: "`fail` returns queued-contact impact instead of mutating.
        `discard` confirms that matching queued contacts should be discarded.
        Defaults to `fail` when omitted."
    SimplifiedWorkflow:
      type: object
      properties:
        id:
          type: string
          description: The ID of the workflow.
        url:
          type: string
          format: uri
          description: The URL of the workflow in the Loops app.
          examples:
            - https://app.loops.so/workflows/clw1a3b5c7d9e1f3g5h7i9j1
        workflowRevisionId:
          $ref: "#/components/schemas/NullableWorkflowRevisionId"
        status:
          type: string
          enum:
            - Draft
            - Sending
            - Paused
            - PausedAndQueueing
        name:
          type: string
          description: The name of the workflow.
        description:
          type: string
          description: The description of the workflow.
        workflowGroupId:
          type: string
          description: The ID of the workflow group this workflow belongs to.
        mailingListId:
          type:
            - string
            - "null"
          description: The ID of the mailing list the workflow sends to.
        rootNodeId:
          type: string
          description: The ID of the root node in the workflow graph.
        nodes:
          type: object
          description: A map of node IDs to simplified node objects. Each node includes
            `typeName` and `nextNodeIds`, plus type-specific fields when
            present. To get the full node object, use the `GET
            /v1/workflows/{workflowId}/nodes/{nodeId}` endpoint.
          additionalProperties:
            $ref: "#/components/schemas/SimplifiedWorkflowNode"
          example:
            cf16k73gq014h3mmj5b6jdi9r:
              typeName: SignupTrigger
              nextNodeIds:
                - cf16k73gq014h3mmj5b4jdifg
                - cf16k73gq014h3mmj5b4jdifh
      required:
        - id
        - url
        - workflowRevisionId
        - status
        - workflowGroupId
        - mailingListId
        - rootNodeId
        - nodes
      examples:
        - id: clw1a3b5c7d9e1f3g5h7i9j1
          url: https://app.loops.so/workflows/clw1a3b5c7d9e1f3g5h7i9j1
          workflowRevisionId: clx7a3b5c7d9e1f3g5h7i9j2
          status: Draft
          name: Welcome series
          description: Onboarding emails for new signups
          workflowGroupId: clg7n5p3q1r9s7t5u3v1w9y7
          mailingListId: clm2k8j4h6g0f8d6s4a2b0z8
          rootNodeId: cln8p0q2r4s6t8u0v2w4x6z8
          nodes:
            cln8p0q2r4s6t8u0v2w4x6z8:
              typeName: SignupTrigger
              nextNodeIds:
                - cln1a3b5c7d9e1f3g5h7i9j1
            cln1a3b5c7d9e1f3g5h7i9j1:
              typeName: SendEmailAction
              nextNodeIds: []
              emailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
              subject: Welcome to Acme!
    CreateWorkflowRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the workflow.
        description:
          type: string
          description: The description of the workflow.
        mailingListId:
          type:
            - string
            - "null"
          description: The ID of a mailing list the workflow sends to. After creation, the
            mailing list can be changed with the
            `/v1/workflows/{workflowId}/mailing-list` endpoint.
        workflowGroupId:
          type: string
          description: The ID of the workflow group to create this workflow in. Defaults
            to the team's Unsorted group when omitted.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
      required:
        - name
      additionalProperties: false
    UpdateWorkflowPropertiesRequest:
      type: object
      description: At least one property must be provided.
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        name:
          type: string
          description: The updated workflow name.
        description:
          type: string
          description: The updated workflow description.
        workflowGroupId:
          type: string
          description: The ID of the workflow group to move this workflow into.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
      required:
        - expectedRevisionId
      anyOf:
        - title: Name
          required:
            - name
        - title: Description
          required:
            - description
        - title: Workflow group
          required:
            - workflowGroupId
      additionalProperties: false
    DeleteWorkflowRequest:
      type: object
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        confirmDelete:
          type: boolean
          description: Set to `true` after a confirmation-required `409 Conflict` response
            to confirm deleting a sending workflow or a workflow with queued
            contacts.
      required:
        - expectedRevisionId
      additionalProperties: false
    WorkflowMutationNode:
      description: Detailed workflow node returned from create and update mutations.
        The exact fields depend on `typeName`.
      oneOf:
        - $ref: "#/components/schemas/SignupTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/EventTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/ContactPropertyTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/AddToListTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/BlankTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/AudienceFilterWorkflowMutationNode"
        - $ref: "#/components/schemas/TimerActionWorkflowMutationNode"
        - $ref: "#/components/schemas/SendEmailActionWorkflowMutationNode"
        - $ref: "#/components/schemas/ExitActionWorkflowMutationNode"
        - $ref: "#/components/schemas/BranchWorkflowMutationNode"
        - $ref: "#/components/schemas/ExperimentBranchWorkflowMutationNode"
        - $ref: "#/components/schemas/VariantWorkflowMutationNode"
      discriminator:
        propertyName: typeName
        mapping:
          SignupTrigger: "#/components/schemas/SignupTriggerWorkflowMutationNode"
          EventTrigger: "#/components/schemas/EventTriggerWorkflowMutationNode"
          ContactPropertyTrigger: "#/components/schemas/ContactPropertyTriggerWorkflowMutationNode"
          AddToListTrigger: "#/components/schemas/AddToListTriggerWorkflowMutationNode"
          BlankTrigger: "#/components/schemas/BlankTriggerWorkflowMutationNode"
          AudienceFilter: "#/components/schemas/AudienceFilterWorkflowMutationNode"
          TimerAction: "#/components/schemas/TimerActionWorkflowMutationNode"
          SendEmailAction: "#/components/schemas/SendEmailActionWorkflowMutationNode"
          ExitAction: "#/components/schemas/ExitActionWorkflowMutationNode"
          BranchNode: "#/components/schemas/BranchWorkflowMutationNode"
          ExperimentBranchNode: "#/components/schemas/ExperimentBranchWorkflowMutationNode"
          VariantNode: "#/components/schemas/VariantWorkflowMutationNode"
    WorkflowMutationNodeRevision:
      type: object
      properties:
        workflowRevisionId:
          $ref: "#/components/schemas/WorkflowRevisionId"
      required:
        - workflowRevisionId
    SignupTriggerWorkflowMutationNode:
      title: Signup trigger
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - SignupTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - id
        - typeName
        - nextNodeIds
    EventTriggerWorkflowMutationNode:
      title: Event trigger
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - EventTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        eventName:
          type: string
          description: The name of the event pattern that triggers this node.
        eventProperties:
          type: array
          items:
            $ref: "#/components/schemas/WorkflowEventProperty"
          description: The properties of the event pattern, which can be used in emails.
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - id
        - typeName
        - nextNodeIds
        - reEligible
    ContactPropertyTriggerWorkflowMutationNode:
      title: Contact property trigger
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - ContactPropertyTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        contactPropertyQuery:
          oneOf:
            - $ref: "#/components/schemas/WorkflowContactPropertyQuery"
            - title: "Null"
              type: "null"
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - id
        - typeName
        - nextNodeIds
        - contactPropertyQuery
        - reEligible
    AddToListTriggerWorkflowMutationNode:
      title: Add-to-list trigger
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - AddToListTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        mailingListId:
          type:
            - string
            - "null"
          description: The ID of the mailing list this trigger sends to, if set.
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - id
        - typeName
        - nextNodeIds
        - mailingListId
        - reEligible
    BlankTriggerWorkflowMutationNode:
      title: Blank trigger
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - BlankTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - id
        - typeName
        - nextNodeIds
    AudienceFilterWorkflowMutationNode:
      title: Audience filter node
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - AudienceFilter
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        audienceFilter:
          $ref: "#/components/schemas/AudienceFilter"
        audienceSegmentId:
          type: string
          description: The ID of the audience segment this trigger targets.
        appliesDownstream:
          description: If `true`, the audience filter will apply to all downstream nodes.
            If `false`, the audience filter will only apply to the current node.
            Matches the "Filter scope" option in the UI.
          type: boolean
      required:
        - id
        - typeName
        - nextNodeIds
        - appliesDownstream
    TimerActionWorkflowMutationNode:
      title: Timer node
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - TimerAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        amount:
          $ref: "#/components/schemas/WorkflowTimerAmount"
        unit:
          $ref: "#/components/schemas/WorkflowTimerUnit"
      required:
        - id
        - typeName
        - nextNodeIds
        - amount
        - unit
    SendEmailActionWorkflowMutationNode:
      title: Send email node
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - SendEmailAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        emailMessageId:
          type: string
          description: The ID of the email message to send. To edit this email, use the
            `POST /v1/email-messages/{emailMessageId}` endpoint.
        subject:
          type: string
      required:
        - id
        - typeName
        - nextNodeIds
        - emailMessageId
        - subject
    ExitActionWorkflowMutationNode:
      title: Exit node
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - ExitAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - id
        - typeName
        - nextNodeIds
    BranchWorkflowMutationNode:
      title: Branch node
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - BranchNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - id
        - typeName
        - nextNodeIds
    ExperimentBranchWorkflowMutationNode:
      title: Experiment node
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - ExperimentBranchNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        samplingRate:
          type: number
          description: The percentage of contacts that will be sent to variant branches,
            between `0` and `100`. The remaining percentage will be sent to the
            control branch. `100` sends all contacts to variant branches.
      required:
        - id
        - typeName
        - nextNodeIds
        - samplingRate
    VariantWorkflowMutationNode:
      title: Variant node
      type: object
      properties:
        id:
          type: string
        typeName:
          type: string
          enum:
            - VariantNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        isControl:
          type: boolean
          description: Whether this is the control variant of an experiment.
      required:
        - id
        - typeName
        - nextNodeIds
    UpdateWorkflowNodePayload:
      anyOf:
        - $ref: "#/components/schemas/WorkflowSignupTriggerPayload"
        - $ref: "#/components/schemas/WorkflowEventTriggerPayload"
        - $ref: "#/components/schemas/WorkflowContactPropertyTriggerPayload"
        - $ref: "#/components/schemas/WorkflowAddToListTriggerPayload"
        - $ref: "#/components/schemas/WorkflowAudienceFilterPayload"
        - $ref: "#/components/schemas/WorkflowTimerActionPayload"
        - $ref: "#/components/schemas/WorkflowExperimentBranchPayload"
        - $ref: "#/components/schemas/WorkflowVariantPayload"
      description: Node-type-specific fields to update. The allowed fields depend on
        the existing node type. Trigger node updates may include `typeName` when
        changing one trigger node type to another trigger node type.
    WorkflowSignupTriggerPayload:
      title: Signup trigger
      type: object
      description: Changes an existing trigger node to a signup trigger.
      properties:
        typeName:
          type: string
          enum:
            - SignupTrigger
      required:
        - typeName
      additionalProperties: false
    WorkflowEventTriggerPayload:
      title: Event trigger
      type: object
      description: Updates an event trigger, or changes an existing trigger node to an
        event trigger. Assign the event pattern with either `eventPatternId` or
        `eventName`, not both. Set either field to `null` to clear the
        event-pattern relationship.
      minProperties: 1
      properties:
        typeName:
          type: string
          enum:
            - EventTrigger
        eventPatternId:
          type:
            - string
            - "null"
          description: The ID of the event pattern to trigger on. Use either
            `eventPatternId` or `eventName`, not both. Set to `null` to clear
            the event-pattern relationship.
        eventName:
          type:
            - string
            - "null"
          description: The name of the event pattern to trigger on. Use this when you know
            the event name but not the internal event pattern ID. Use either
            `eventName` or `eventPatternId`, not both. Set to `null` to clear
            the event-pattern relationship.
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      additionalProperties: false
    WorkflowContactPropertyTriggerPayload:
      title: Contact property trigger
      type: object
      description: Updates a contact-property trigger, or changes an existing trigger
        node to a contact-property trigger.
      minProperties: 1
      properties:
        typeName:
          type: string
          enum:
            - ContactPropertyTrigger
        contactPropertyQuery:
          $ref: "#/components/schemas/WorkflowContactPropertyQuery"
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      additionalProperties: false
    WorkflowAddToListTriggerPayload:
      title: Add-to-list trigger
      type: object
      description: Updates an add-to-list trigger, or changes an existing trigger node
        to an add-to-list trigger.
      minProperties: 1
      properties:
        typeName:
          type: string
          enum:
            - AddToListTrigger
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      additionalProperties: false
    WorkflowAudienceFilterPayload:
      title: Audience filter node
      type: object
      minProperties: 1
      description: Configuration for the audience filter node.
      properties:
        audienceSegmentId:
          type:
            - string
            - "null"
          description: The ID of an audience segment. Setting this without also providing
            `audienceFilter` clears any existing `audienceFilter`. If both are
            provided, the filter is applied on top of the segment's filter.
        audienceFilter:
          $ref: "#/components/schemas/AudienceFilterInRequest"
        appliesDownstream:
          type: boolean
          description: If `true`, the audience filter will apply to all downstream nodes.
            If `false`, the audience filter will only apply to the current node.
            Matches the "Filter scope" option in the UI.
      additionalProperties: false
    WorkflowTimerActionPayload:
      title: Timer node
      type: object
      minProperties: 1
      description: Configuration for the timer action node.
      properties:
        amount:
          $ref: "#/components/schemas/WorkflowTimerAmount"
        unit:
          $ref: "#/components/schemas/WorkflowTimerUnit"
      additionalProperties: false
    WorkflowExperimentBranchPayload:
      title: Experiment node
      type: object
      minProperties: 1
      description: Configuration for the experiment branch node.
      properties:
        samplingRate:
          type: number
          description: The percentage of contacts that will be sent to variant branches,
            between `0` and `100`. The remaining percentage will be sent to the
            control branch. `100` sends all contacts to variant branches.
      additionalProperties: false
    WorkflowVariantPayload:
      title: Variant node
      type: object
      minProperties: 1
      description: Configuration for the variant node.
      properties:
        isControl:
          type: boolean
          description: Use `true` to set this variant as the control of the experiment.
            This will set `false` on the existing control, if one exists.
            Experiments do not require a control variant.
      additionalProperties: false
    CreateWorkflowNodeTypeName:
      type: string
      enum:
        - AudienceFilter
        - BranchNode
        - ExperimentBranchNode
        - TimerAction
        - SendEmailAction
        - VariantNode
      description: Node types that can be created with the API. `*Trigger` nodes and
        `ExitAction` nodes cannot be created.
    CreateWorkflowNodeBetweenRequest:
      title: Between nodes
      type: object
      description: Insert a new node between two existing nodes, `fromNodeId` and
        `toNodeId`. When `fromNodeId` is an `ExperimentBranchNode`,
        `nodeTypeName` must be `VariantNode`, and `toNodeId` cannot already be a
        `VariantNode`; use add-branch to add sibling variants. Branch paths can
        be edited with create-node, but a workflow cannot be started unless each
        direct `BranchNode` child is an `AudienceFilter`.
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        insertMode:
          type: string
          enum:
            - between
        nodeTypeName:
          $ref: "#/components/schemas/CreateWorkflowNodeTypeName"
        fromNodeId:
          type: string
          description: The node to insert after. This node must currently point to
            `toNodeId`. If this is an `ExperimentBranchNode`, `nodeTypeName`
            must be `VariantNode` and `toNodeId` cannot already be a
            `VariantNode`.
        toNodeId:
          type: string
          description: The node to insert before.
      required:
        - expectedRevisionId
        - insertMode
        - nodeTypeName
        - fromNodeId
        - toNodeId
      additionalProperties: false
    CreateWorkflowNodeBeforeRequest:
      title: Before a node
      type: object
      description: 'Insert a new node before `toNodeId`. `VariantNode` cannot use
        `insertMode: "before"`; to restore a missing variant path, use
        `insertMode: "between"` with the experiment branch as `fromNodeId`.'
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        insertMode:
          type: string
          enum:
            - before
        nodeTypeName:
          $ref: "#/components/schemas/CreateWorkflowNodeTypeName"
        toNodeId:
          type: string
          description: The node to insert before. The target must have at least one
            incoming parent and cannot be a trigger node.
        beforeNodeId:
          type: string
          description: Deprecated. Use `toNodeId` instead.
          deprecated: true
      required:
        - expectedRevisionId
        - insertMode
        - nodeTypeName
      oneOf:
        - title: Target node
          properties:
            toNodeId:
              type: string
          required:
            - toNodeId
        - title: Target node (deprecated)
          properties:
            beforeNodeId:
              type: string
              deprecated: true
          required:
            - beforeNodeId
      additionalProperties: false
    CreateWorkflowNodeAfterRequest:
      title: After a node
      type: object
      description: Insert a new node after `fromNodeId`. This is valid only when
        `fromNodeId` has exactly one outgoing node. It is invalid when
        `fromNodeId` has no outgoing nodes, multiple outgoing nodes, or is an
        exit node. When the source has multiple outgoing nodes, use `between`
        with the exact `toNodeId` instead.
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        insertMode:
          type: string
          enum:
            - after
        nodeTypeName:
          $ref: "#/components/schemas/CreateWorkflowNodeTypeName"
        fromNodeId:
          type: string
          description: The node to insert after. This node must currently have exactly one
            outgoing node.
      required:
        - expectedRevisionId
        - insertMode
        - nodeTypeName
        - fromNodeId
      additionalProperties: false
    CreateWorkflowNodeRequest:
      oneOf:
        - $ref: "#/components/schemas/CreateWorkflowNodeBetweenRequest"
        - $ref: "#/components/schemas/CreateWorkflowNodeBeforeRequest"
        - $ref: "#/components/schemas/CreateWorkflowNodeAfterRequest"
      description: Create a new workflow node with an explicit `insertMode`. To
        configure the node after creation, use the `POST
        /v1/workflows/{workflowId}/nodes/{nodeId}` endpoint.
      discriminator:
        propertyName: insertMode
        mapping:
          between: "#/components/schemas/CreateWorkflowNodeBetweenRequest"
          before: "#/components/schemas/CreateWorkflowNodeBeforeRequest"
          after: "#/components/schemas/CreateWorkflowNodeAfterRequest"
    WorkflowMutationNodeWithRevision:
      description: Detailed workflow node returned from a mutation, plus the latest
        workflow revision token.
      oneOf:
        - $ref: "#/components/schemas/SignupTriggerWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/EventTriggerWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/ContactPropertyTriggerWorkflowMutationNodeWithRevis\
            ion"
        - $ref: "#/components/schemas/AddToListTriggerWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/BlankTriggerWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/AudienceFilterWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/TimerActionWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/SendEmailActionWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/ExitActionWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/BranchWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/ExperimentBranchWorkflowMutationNodeWithRevision"
        - $ref: "#/components/schemas/VariantWorkflowMutationNodeWithRevision"
      discriminator:
        propertyName: typeName
        mapping:
          SignupTrigger: "#/components/schemas/SignupTriggerWorkflowMutationNodeWithRevision"
          EventTrigger: "#/components/schemas/EventTriggerWorkflowMutationNodeWithRevision"
          ContactPropertyTrigger: "#/components/schemas/ContactPropertyTriggerWorkflowMut\
            ationNodeWithRevision"
          AddToListTrigger: "#/components/schemas/AddToListTriggerWorkflowMutationNodeWit\
            hRevision"
          BlankTrigger: "#/components/schemas/BlankTriggerWorkflowMutationNodeWithRevision"
          AudienceFilter: "#/components/schemas/AudienceFilterWorkflowMutationNodeWithRevision"
          TimerAction: "#/components/schemas/TimerActionWorkflowMutationNodeWithRevision"
          SendEmailAction: "#/components/schemas/SendEmailActionWorkflowMutationNodeWithR\
            evision"
          ExitAction: "#/components/schemas/ExitActionWorkflowMutationNodeWithRevision"
          BranchNode: "#/components/schemas/BranchWorkflowMutationNodeWithRevision"
          ExperimentBranchNode: "#/components/schemas/ExperimentBranchWorkflowMutationNod\
            eWithRevision"
          VariantNode: "#/components/schemas/VariantWorkflowMutationNodeWithRevision"
    SignupTriggerWorkflowMutationNodeWithRevision:
      title: Signup trigger
      allOf:
        - $ref: "#/components/schemas/SignupTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    EventTriggerWorkflowMutationNodeWithRevision:
      title: Event trigger
      allOf:
        - $ref: "#/components/schemas/EventTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    ContactPropertyTriggerWorkflowMutationNodeWithRevision:
      title: Contact property trigger
      allOf:
        - $ref: "#/components/schemas/ContactPropertyTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    AddToListTriggerWorkflowMutationNodeWithRevision:
      title: Add-to-list trigger
      allOf:
        - $ref: "#/components/schemas/AddToListTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    BlankTriggerWorkflowMutationNodeWithRevision:
      title: Blank trigger
      allOf:
        - $ref: "#/components/schemas/BlankTriggerWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    AudienceFilterWorkflowMutationNodeWithRevision:
      title: Audience filter node
      allOf:
        - $ref: "#/components/schemas/AudienceFilterWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    TimerActionWorkflowMutationNodeWithRevision:
      title: Timer node
      allOf:
        - $ref: "#/components/schemas/TimerActionWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    SendEmailActionWorkflowMutationNodeWithRevision:
      title: Send email node
      allOf:
        - $ref: "#/components/schemas/SendEmailActionWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    ExitActionWorkflowMutationNodeWithRevision:
      title: Exit node
      allOf:
        - $ref: "#/components/schemas/ExitActionWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    BranchWorkflowMutationNodeWithRevision:
      title: Branch node
      allOf:
        - $ref: "#/components/schemas/BranchWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    ExperimentBranchWorkflowMutationNodeWithRevision:
      title: Experiment node
      allOf:
        - $ref: "#/components/schemas/ExperimentBranchWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    VariantWorkflowMutationNodeWithRevision:
      title: Variant node
      allOf:
        - $ref: "#/components/schemas/VariantWorkflowMutationNode"
        - $ref: "#/components/schemas/WorkflowMutationNodeRevision"
    CreatedWorkflowNode:
      allOf:
        - $ref: "#/components/schemas/WorkflowMutationNodeWithRevision"
        - type: object
          properties:
            createdChildNodes:
              type: array
              description: Default child nodes created along with the requested node.
                BranchNode creation returns two AudienceFilter children.
                ExperimentBranchNode creation returns two regular VariantNode
                children and one control VariantNode.
              items:
                $ref: "#/components/schemas/WorkflowMutationNode"
    CreateWorkflowNodeResponse:
      type: object
      properties:
        node:
          $ref: "#/components/schemas/CreatedWorkflowNode"
        workflow:
          $ref: "#/components/schemas/SimplifiedWorkflow"
      required:
        - node
        - workflow
      additionalProperties: false
    AddWorkflowBranchRequest:
      type: object
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
      required:
        - expectedRevisionId
      additionalProperties: false
    AddWorkflowBranchResponse:
      type: object
      properties:
        node:
          $ref: "#/components/schemas/WorkflowMutationNodeWithRevision"
        workflow:
          $ref: "#/components/schemas/SimplifiedWorkflow"
      required:
        - node
        - workflow
      additionalProperties: false
    RerouteNodeConnectionRequest:
      type: object
      description: Reroute the source node's only outgoing connection to `newTargetNodeId`.
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        newTargetNodeId:
          type: string
          description: The valid workflow node that should receive the connection from the
            source node.
          examples:
            - cln3c5d7e9f1g3h5i7j9k1l3
      required:
        - expectedRevisionId
        - newTargetNodeId
      additionalProperties: false
      examples:
        - expectedRevisionId: clx7a3b5c7d9e1f3g5h7i9j1
          newTargetNodeId: cln3c5d7e9f1g3h5i7j9k1l3
    RerouteNodeConnectionResponse:
      description: The updated source node, plus the latest workflow.
      allOf:
        - $ref: "#/components/schemas/WorkflowMutationNodeWithRevision"
        - type: object
          properties:
            workflow:
              $ref: "#/components/schemas/SimplifiedWorkflow"
          required:
            - workflow
      examples:
        - id: cln8p0q2r4s6t8u0v2w4x6z8
          typeName: SignupTrigger
          nextNodeIds:
            - cln3c5d7e9f1g3h5i7j9k1l3
          workflowRevisionId: clx7a3b5c7d9e1f3g5h7i9j2
          workflow:
            id: clw1a3b5c7d9e1f3g5h7i9j1
            url: https://app.loops.so/workflows/clw1a3b5c7d9e1f3g5h7i9j1
            workflowRevisionId: clx7a3b5c7d9e1f3g5h7i9j2
            status: Draft
            name: Welcome series
            description: Onboarding emails for new signups
            workflowGroupId: clg7n5p3q1r9s7t5u3v1w9y7
            mailingListId: clm2k8j4h6g0f8d6s4a2b0z8
            rootNodeId: cln8p0q2r4s6t8u0v2w4x6z8
            nodes:
              cln8p0q2r4s6t8u0v2w4x6z8:
                typeName: SignupTrigger
                nextNodeIds:
                  - cln3c5d7e9f1g3h5i7j9k1l3
              cln1a3b5c7d9e1f3g5h7i9j1:
                typeName: AudienceFilter
                nextNodeIds:
                  - cln3c5d7e9f1g3h5i7j9k1l3
              cln3c5d7e9f1g3h5i7j9k1l3:
                typeName: SendEmailAction
                nextNodeIds: []
                emailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
                subject: Welcome to Acme!
    UpdateWorkflowNodeRequest:
      type: object
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        payload:
          $ref: "#/components/schemas/UpdateWorkflowNodePayload"
      required:
        - expectedRevisionId
        - payload
      additionalProperties: false
    UpdateWorkflowNodeResponse:
      description: The updated workflow node, plus the latest simplified workflow.
      allOf:
        - $ref: "#/components/schemas/WorkflowMutationNodeWithRevision"
        - type: object
          properties:
            workflow:
              $ref: "#/components/schemas/SimplifiedWorkflow"
          required:
            - workflow
    DeleteWorkflowNodeRequest:
      type: object
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        dryRun:
          type: boolean
          description: If `true`, the request will be validated but the workflow will not
            be modified.
        queuedContactPolicy:
          $ref: "#/components/schemas/WorkflowQueuedContactPolicy"
      required:
        - expectedRevisionId
      additionalProperties: false
    WorkflowQueuedContactDeletePreview:
      title: Deletion preview
      type: object
      properties:
        status:
          type: string
          enum:
            - dryRun
            - queuedContactsFound
        nodeIds:
          type: array
          items:
            type: string
          description: The IDs of the nodes that would be deleted.
        queuedContactCount:
          type: number
          description: The number of queued contacts that would be removed from the
            workflow due to the node deletion.
      required:
        - status
        - nodeIds
        - queuedContactCount
    WorkflowDeletedResponse:
      title: Nodes deleted
      type: object
      properties:
        status:
          type: string
          enum:
            - deleted
        nodeIds:
          type: array
          items:
            type: string
        workflowRevisionId:
          $ref: "#/components/schemas/WorkflowRevisionId"
        queuedContactCount:
          type: number
          description: The number of queued contacts that were removed from the workflow
            due to the node deletion.
        workflow:
          $ref: "#/components/schemas/SimplifiedWorkflow"
      required:
        - status
        - nodeIds
        - workflowRevisionId
        - queuedContactCount
        - workflow
    DeleteWorkflowNodeResponse:
      oneOf:
        - $ref: "#/components/schemas/WorkflowQueuedContactDeletePreview"
        - $ref: "#/components/schemas/WorkflowDeletedResponse"
    ChangeWorkflowMailingListRequest:
      type: object
      properties:
        expectedRevisionId:
          $ref: "#/components/schemas/WorkflowExpectedRevisionId"
        mailingListId:
          type:
            - string
            - "null"
          description: 'The mailing list to use for the workflow. When assigning a mailing
            list, queued contacts excluded by the new list can return
            `queuedContactsFound`; retry with `queuedContactPolicy: "discard"`
            to apply the change and discard those contacts. Use `null` to clear
            the workflow mailing list; clearing does not discard queued
            contacts.'
        dryRun:
          type: boolean
          description: If `true`, the request will be validated but the workflow will not
            be modified.
        queuedContactPolicy:
          $ref: "#/components/schemas/WorkflowQueuedContactPolicy"
      required:
        - expectedRevisionId
        - mailingListId
      additionalProperties: false
    WorkflowMailingListPreview:
      title: Mailing list change preview
      type: object
      properties:
        status:
          type: string
          enum:
            - dryRun
            - queuedContactsFound
        mailingListId:
          type:
            - string
            - "null"
        queuedContactCount:
          type: number
          description: The number of queued contacts that would be removed from the
            workflow due to the mailing list changing.
      required:
        - status
        - mailingListId
        - queuedContactCount
    WorkflowMailingListUpdatedResponse:
      title: Mailing list updated
      type: object
      properties:
        status:
          type: string
          enum:
            - updated
        mailingListId:
          type:
            - string
            - "null"
        workflowRevisionId:
          $ref: "#/components/schemas/WorkflowRevisionId"
        queuedContactCount:
          type: number
          description: The number of queued contacts that were removed from the workflow
            due to the mailing list changing.
        workflow:
          $ref: "#/components/schemas/SimplifiedWorkflow"
      required:
        - status
        - mailingListId
        - workflowRevisionId
        - queuedContactCount
        - workflow
    ChangeWorkflowMailingListResponse:
      oneOf:
        - $ref: "#/components/schemas/WorkflowMailingListPreview"
        - $ref: "#/components/schemas/WorkflowMailingListUpdatedResponse"
    EventPatternSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the event pattern.
        eventName:
          type: string
          description: The name of the event pattern. Use this when sending events with
            the API.
        incomingWebhookPlatform:
          type:
            - string
            - "null"
          description: The platform that sent this event pattern, if the event pattern is
            from an incoming webhook. Will be `null` for custom events.
          enum:
            - clerk
            - polar
            - stripe
            - supabase
            - "null"
      required:
        - id
        - eventName
        - incomingWebhookPlatform
    ListEventPatternsResponse:
      type: object
      properties:
        pagination:
          type: object
          properties:
            totalResults:
              type: number
            returnedResults:
              type: number
            perPage:
              type: number
            totalPages:
              type: number
            nextCursor:
              type:
                - string
                - "null"
            nextPage:
              type:
                - string
                - "null"
        data:
          type: array
          items:
            $ref: "#/components/schemas/EventPatternSummary"
      required:
        - pagination
        - data
    EventPattern:
      type: object
      properties:
        id:
          type: string
        eventName:
          type: string
          description: The name of the event pattern. Use this when sending events with
            the API.
        eventProperties:
          type: array
          items:
            $ref: "#/components/schemas/WorkflowEventProperty"
          description: The properties of the event pattern, which can be used in emails.
        incomingWebhookPlatform:
          type:
            - string
            - "null"
          description: The platform that sent this event pattern, if the event pattern is
            from an incoming webhook. Will be `null` for custom events.
          enum:
            - clerk
            - polar
            - stripe
            - supabase
            - "null"
      required:
        - id
        - eventName
        - eventProperties
        - incomingWebhookPlatform
    EventPatternFailureResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    SimplifiedWorkflowNode:
      oneOf:
        - $ref: "#/components/schemas/SimplifiedSignupTriggerWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedEventTriggerWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedContactPropertyTriggerWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedAddToListTriggerWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedBlankTriggerWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedAudienceFilterWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedTimerActionWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedSendEmailActionWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedExitActionWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedBranchWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedExperimentBranchWorkflowNode"
        - $ref: "#/components/schemas/SimplifiedVariantWorkflowNode"
      discriminator:
        propertyName: typeName
    SimplifiedSignupTriggerWorkflowNode:
      title: Signup trigger
      type: object
      properties:
        typeName:
          type: string
          enum:
            - SignupTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - typeName
        - nextNodeIds
      additionalProperties: false
    SimplifiedEventTriggerWorkflowNode:
      title: Event trigger
      type: object
      properties:
        typeName:
          type: string
          enum:
            - EventTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        eventName:
          type:
            - string
            - "null"
          description: The name of the event that triggers the workflow.
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - typeName
        - nextNodeIds
        - eventName
        - reEligible
      additionalProperties: false
      examples:
        - typeName: EventTrigger
          nextNodeIds:
            - cln1a3b5c7d9e1f3g5h7i9j1
          eventName: signup
          reEligible: false
    SimplifiedContactPropertyTriggerWorkflowNode:
      title: Contact property trigger
      type: object
      properties:
        typeName:
          type: string
          enum:
            - ContactPropertyTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        contactPropertyQuery:
          oneOf:
            - $ref: "#/components/schemas/WorkflowContactPropertyQuery"
            - title: "Null"
              type: "null"
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - typeName
        - nextNodeIds
        - contactPropertyQuery
        - reEligible
      additionalProperties: false
    SimplifiedAddToListTriggerWorkflowNode:
      title: Add-to-list trigger
      type: object
      properties:
        typeName:
          type: string
          enum:
            - AddToListTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        mailingListId:
          type:
            - string
            - "null"
          description: The ID of the mailing list that triggers the workflow.
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - typeName
        - nextNodeIds
        - mailingListId
        - reEligible
      additionalProperties: false
    SimplifiedBlankTriggerWorkflowNode:
      title: Blank trigger
      type: object
      properties:
        typeName:
          type: string
          enum:
            - BlankTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - typeName
        - nextNodeIds
      additionalProperties: false
    SimplifiedAudienceFilterWorkflowNode:
      title: Audience filter node
      type: object
      properties:
        typeName:
          type: string
          enum:
            - AudienceFilter
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - typeName
        - nextNodeIds
      additionalProperties: false
    SimplifiedTimerActionWorkflowNode:
      title: Timer node
      type: object
      properties:
        typeName:
          type: string
          enum:
            - TimerAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        amount:
          $ref: "#/components/schemas/WorkflowTimerAmount"
        unit:
          $ref: "#/components/schemas/WorkflowTimerUnit"
      required:
        - typeName
        - nextNodeIds
        - amount
        - unit
      additionalProperties: false
      examples:
        - typeName: TimerAction
          nextNodeIds:
            - cln1a3b5c7d9e1f3g5h7i9j1
          amount: 2
          unit: d
    SimplifiedSendEmailActionWorkflowNode:
      title: Send email node
      type: object
      properties:
        typeName:
          type: string
          enum:
            - SendEmailAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        emailMessageId:
          type:
            - string
            - "null"
          description: The ID of the email message to send. To edit this email, use the
            `POST /v1/email-messages/{emailMessageId}` endpoint.
        subject:
          type: string
          description: The subject of the email message (reference only).
      required:
        - typeName
        - nextNodeIds
        - emailMessageId
        - subject
      additionalProperties: false
      examples:
        - typeName: SendEmailAction
          nextNodeIds: []
          emailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          subject: Welcome to Acme!
    SimplifiedExitActionWorkflowNode:
      title: Exit node
      type: object
      properties:
        typeName:
          type: string
          enum:
            - ExitAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - typeName
        - nextNodeIds
      additionalProperties: false
    SimplifiedBranchWorkflowNode:
      title: Branch node
      type: object
      properties:
        typeName:
          type: string
          enum:
            - BranchNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - typeName
        - nextNodeIds
      additionalProperties: false
    SimplifiedExperimentBranchWorkflowNode:
      title: Experiment node
      type: object
      properties:
        typeName:
          type: string
          enum:
            - ExperimentBranchNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        samplingRate:
          type: number
          description: The percentage of contacts that will be sent to variant branches,
            between `0` and `100`. The remaining percentage will be sent to the
            control branch.
      required:
        - typeName
        - nextNodeIds
        - samplingRate
      additionalProperties: false
    SimplifiedVariantWorkflowNode:
      title: Variant node
      type: object
      properties:
        typeName:
          type: string
          enum:
            - VariantNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        isControl:
          type: boolean
          description: Whether this is the control variant of an experiment.
      required:
        - typeName
        - nextNodeIds
        - isControl
      additionalProperties: false
    WorkflowNode:
      oneOf:
        - $ref: "#/components/schemas/SignupTriggerWorkflowNode"
        - $ref: "#/components/schemas/EventTriggerWorkflowNode"
        - $ref: "#/components/schemas/ContactPropertyTriggerWorkflowNode"
        - $ref: "#/components/schemas/AddToListTriggerWorkflowNode"
        - $ref: "#/components/schemas/BlankTriggerWorkflowNode"
        - $ref: "#/components/schemas/AudienceFilterWorkflowNode"
        - $ref: "#/components/schemas/TimerActionWorkflowNode"
        - $ref: "#/components/schemas/SendEmailActionWorkflowNode"
        - $ref: "#/components/schemas/ExitActionWorkflowNode"
        - $ref: "#/components/schemas/BranchWorkflowNode"
        - $ref: "#/components/schemas/ExperimentBranchWorkflowNode"
        - $ref: "#/components/schemas/VariantWorkflowNode"
      discriminator:
        propertyName: typeName
    WorkflowNodeWithRevision:
      description: Detailed workflow node returned from read operations. The exact
        fields depend on `typeName`.
      allOf:
        - $ref: "#/components/schemas/WorkflowNode"
        - type: object
          properties:
            workflowRevisionId:
              $ref: "#/components/schemas/NullableWorkflowRevisionId"
          required:
            - workflowRevisionId
    SignupTriggerWorkflowNode:
      title: Signup trigger
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - SignupTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
      additionalProperties: false
    EventTriggerWorkflowNode:
      title: Event trigger
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - EventTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        eventName:
          type: string
          examples:
            - signup
          description: The name of the event pattern that triggers this node.
        eventProperties:
          type: array
          items:
            $ref: "#/components/schemas/WorkflowEventProperty"
          description: The properties of the event pattern, which can be used in emails.
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
        - reEligible
      additionalProperties: false
    ContactPropertyTriggerWorkflowNode:
      title: Contact property trigger
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - ContactPropertyTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        contactPropertyQuery:
          oneOf:
            - $ref: "#/components/schemas/WorkflowContactPropertyQuery"
            - title: "Null"
              type: "null"
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
        - contactPropertyQuery
        - reEligible
      additionalProperties: false
    AddToListTriggerWorkflowNode:
      title: Add-to-list trigger
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - AddToListTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        mailingListId:
          type:
            - string
            - "null"
          examples:
            - clm2k8j4h6g0f8d6s4a2b0z8
            - null
          description: The ID of the mailing list that triggers the workflow.
        reEligible:
          $ref: "#/components/schemas/WorkflowReEligible"
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
        - mailingListId
        - reEligible
      additionalProperties: false
    BlankTriggerWorkflowNode:
      title: Blank trigger
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - BlankTrigger
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
      additionalProperties: false
    AudienceFilterWorkflowNode:
      title: Audience filter node
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - AudienceFilter
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        audienceFilter:
          $ref: "#/components/schemas/AudienceFilter"
        audienceSegmentId:
          type: string
        appliesDownstream:
          description: If `true`, the audience filter will apply to all downstream nodes.
            If `false`, the audience filter will only apply to the current node.
            Matches the "Filter scope" option in the UI.
          type: boolean
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
        - appliesDownstream
      additionalProperties: false
    TimerActionWorkflowNode:
      title: Timer node
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - TimerAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        amount:
          $ref: "#/components/schemas/WorkflowTimerAmount"
        unit:
          $ref: "#/components/schemas/WorkflowTimerUnit"
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
        - amount
        - unit
      additionalProperties: false
    SendEmailActionWorkflowNode:
      title: Send email node
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - SendEmailAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        emailMessageId:
          type: string
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
          description: The ID of the email message to send. To edit this email, use the
            `POST /v1/email-messages/{emailMessageId}` endpoint.
        subject:
          type: string
          examples:
            - Welcome to Acme!
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
        - emailMessageId
        - subject
      additionalProperties: false
    ExitActionWorkflowNode:
      title: Exit node
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - ExitAction
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
      additionalProperties: false
    BranchWorkflowNode:
      title: Branch node
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - BranchNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
      additionalProperties: false
    ExperimentBranchWorkflowNode:
      title: Experiment node
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - ExperimentBranchNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        samplingRate:
          type: number
          description: The percentage of contacts that will be sent to variant branches,
            between `0` and `100`. The remaining percentage will be sent to the
            control branch. `100` sends all contacts to variant branches.
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
        - samplingRate
      additionalProperties: false
    VariantWorkflowNode:
      title: Variant node
      type: object
      properties:
        id:
          type: string
          examples:
            - cln8p0q2r4s6t8u0v2w4x6z8
        workflowId:
          type: string
          examples:
            - clw1a3b5c7d9e1f3g5h7i9j1
        typeName:
          type: string
          enum:
            - VariantNode
        nextNodeIds:
          $ref: "#/components/schemas/WorkflowNextNodeIds"
        isControl:
          type: boolean
          description: Whether this is the control variant of an experiment.
      required:
        - id
        - workflowId
        - typeName
        - nextNodeIds
      additionalProperties: false
    WorkflowEventProperty:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
          enum:
            - string
            - number
            - boolean
            - date
      required:
        - name
        - type
    WorkflowContactPropertyQuery:
      title: Contact property query
      type: object
      description: Define the contact property change that triggers the workflow. In
        update requests, `key` must resolve to an existing contact property that
        is available for Contact Updated triggers. Hidden or unsupported fields,
        such as `createdAt`, `notes`, and computed contact properties, are
        rejected.
      properties:
        key:
          type: string
          description: The camel-cased `key` of the contact property to query. The
            property must exist for the team and must be available for Contact
            Updated triggers.
          examples:
            - firstName
            - email
            - planName
        is:
          description: Comparison for the new contact property value after the update.
          $ref: "#/components/schemas/WorkflowContactPropertyComparison"
        was:
          description: Comparison for the previous contact property value before the update.
          $ref: "#/components/schemas/WorkflowContactPropertyComparison"
      required:
        - key
        - is
        - was
    WorkflowContactPropertyComparison:
      type: object
      description: For Contact Updated triggers, the API validates `operator` against
        the selected contact property's type and the side of the comparison. The
        `was` comparison can use any operator supported by the selected property
        type. The `is` comparison uses the same operators, except number and
        boolean properties cannot use `empty`. String properties support `any`,
        `equal`, `not_equal`, `contains`, `not_contains`, `empty`, and
        `not_empty`. Number properties support `any`, `greater_than`,
        `less_than`, `numeric_equal`, `numeric_not_equal`, `empty`, and
        `not_empty`. Boolean properties support `any`, `true`, `false`, `empty`,
        and `not_empty`. Date properties support `any`, `empty`, `not_empty`,
        `after`, `before`, and `between`.
      properties:
        value:
          oneOf:
            - title: String
              type: string
            - title: Number
              type: number
            - title: Boolean
              type: boolean
        operator:
          type: string
          description: The comparison operator. It must be valid for the selected contact
            property's type and for the `is` or `was` side of the comparison.
            Number and boolean properties allow `empty` on `was`, but not on
            `is`.
          enum:
            - any
            - contains
            - not_contains
            - empty
            - not_empty
            - equal
            - not_equal
            - greater_than
            - less_than
            - "true"
            - "false"
            - numeric_equal
            - numeric_not_equal
            - after
            - before
            - between
      required:
        - value
        - operator
    WorkflowTimerAmount:
      type: number
      description: The amount of time to wait before triggering the next node. Set to
        `0` to move to the next node immediately.
    WorkflowTimerUnit:
      type: string
      enum:
        - m
        - h
        - d
      description: The unit of time for the timer action node. m = minutes, h = hours,
        d = days.
    WorkflowFailureResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      examples:
        - message: Workflow not found.
    GroupResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the group.
          examples:
            - clg7n5p3q1r9s7t5u3v1w9y7
        name:
          type: string
          description: The name of the group.
          examples:
            - Onboarding
        description:
          type: string
          description: The description of the group.
          examples:
            - Top of funnel campaigns
        createdAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
          description: ISO 8601 timestamp for when the group was created.
        updatedAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
          description: ISO 8601 timestamp for when the group was last updated.
      required:
        - id
        - name
        - description
        - createdAt
        - updatedAt
      examples:
        - id: clg7n5p3q1r9s7t5u3v1w9y7
          name: Onboarding
          description: Top of funnel campaigns
          createdAt: 2025-06-29T07:47:39.370Z
          updatedAt: 2025-06-29T07:47:39.370Z
    ListGroupsResponse:
      type: object
      properties:
        pagination:
          $ref: "#/components/schemas/Pagination"
        data:
          type: array
          items:
            $ref: "#/components/schemas/GroupResponse"
      required:
        - pagination
        - data
      examples:
        - pagination:
            totalResults: 2
            returnedResults: 2
            perPage: 20
            totalPages: 1
            nextCursor: null
            nextPage: null
          data:
            - id: clg7n5p3q1r9s7t5u3v1w9y7
              name: Onboarding
              description: Top of funnel campaigns
              createdAt: 2025-06-29T07:47:39.370Z
              updatedAt: 2025-06-29T07:47:39.370Z
            - id: clg8m4n6p8q0r2s4t6u8v0w2
              name: Retention
              description: ""
              createdAt: 2025-06-30T12:00:00.000Z
              updatedAt: 2025-06-30T12:00:00.000Z
    CreateGroupRequest:
      type: object
      properties:
        name:
          type: string
          description: The group name. Cannot be the reserved name "Unsorted".
          examples:
            - Newsletters
        description:
          type: string
          description: An optional description for the group.
          examples:
            - Monthly newsletter campaigns
      required:
        - name
      additionalProperties: false
      examples:
        - name: Newsletters
          description: Monthly newsletter campaigns
    UpdateGroupRequest:
      type: object
      description: At least one field must be provided.
      properties:
        name:
          type: string
          description: The group name. Cannot be the reserved name "Unsorted".
        description:
          type: string
          description: A description for the group.
      additionalProperties: false
    GroupFailureResponse:
      type: object
      properties:
        message:
          type: string
          examples:
            - Group not found.
      required:
        - message
      examples:
        - message: Group not found.
    UpdateEmailMessageRequest:
      type: object
      properties:
        expectedRevisionId:
          type: string
          description: The `contentRevisionId` you last fetched, or the
            `emailMessageContentRevisionId` you received when creating the
            campaign.
        subject:
          type: string
        previewText:
          type: string
        fromName:
          type: string
        fromEmail:
          type: string
          description: The email sender email address, without the team's sending domain.
          examples:
            - hello
        replyToEmail:
          type: string
          description: Reply-to email. Must be empty or a valid email address.
        ccEmail:
          type: string
          description: CC email address. Requires the team to have CC/BCC enabled. Not
            supported for campaign emails.
        bccEmail:
          type: string
          description: BCC email address. Requires the team to have CC/BCC enabled. Not
            supported for campaign emails.
        languageCode:
          type: string
          description: ISO 639-1 language code for the email, e.g. `en` or `fr`.
        emailFormat:
          type: string
          enum:
            - styled
            - plain
          description: The rendering format of the email.
        lmx:
          type: string
          description: The email body serialized as LMX. Styles must be embedded in the
            LMX `<Style />` tag.
        contactPropertiesFallbacks:
          type: object
          description: "Fallback values for contact properties, keyed by property name.
            Per-key merge: a string value sets the fallback, a null value
            deletes it, and keys omitted from the map are left unchanged."
          additionalProperties:
            type:
              - string
              - "null"
        eventPropertiesFallbacks:
          type: object
          description: "Fallback values for event properties, keyed by property name.
            Per-key merge: a string value sets the fallback, a null value
            deletes it, and keys omitted from the map are left unchanged."
          additionalProperties:
            type:
              - string
              - "null"
        dataVariablesFallbacks:
          type: object
          description: "Fallback values for data variables, keyed by variable name.
            Per-key merge: a string value sets the fallback, a null value
            deletes it, and keys omitted from the map are left unchanged."
          additionalProperties:
            type:
              - string
              - "null"
      additionalProperties: false
      examples:
        - expectedRevisionId: clrev1s10n2i3d4e5f6g7h8
          subject: Spring product updates
          previewText: See what's new this season
          fromName: Acme Team
          fromEmail: hello
          replyToEmail: support@company.com
          emailFormat: styled
          lmx: <Paragraph>Hello, {firstName}!</Paragraph>
          contactPropertiesFallbacks:
            firstName: there
    EmailMessageResponse:
      type: object
      properties:
        id:
          type: string
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
          description: The ID of the email message.
        campaignId:
          type: string
          description: The campaign this email message belongs to. Present only when the
            message belongs to a campaign (mutually exclusive with
            `transactionalId`).
          examples:
            - clc4m6n8p0q2r4s6t8u0v2x4
        transactionalId:
          type: string
          description: The transactional email this email message belongs to. Present only
            when the message belongs to a transactional email (mutually
            exclusive with `campaignId`).
        subject:
          type: string
          description: The email subject.
          examples:
            - Spring product updates
        previewText:
          type: string
          description: The email preview text.
          examples:
            - See what's new this season
        fromName:
          type: string
          description: The email sender name.
          examples:
            - Acme Team
        fromEmail:
          type: string
          description: The email sender email address, without the team's sending domain.
          examples:
            - hello
        replyToEmail:
          type: string
          description: The email reply-to address.
          examples:
            - support@company.com
        ccEmail:
          type: string
          description: The email CC address. Only present when set.
        bccEmail:
          type: string
          description: The email BCC address. Only present when set.
        languageCode:
          type: string
          description: ISO 639-1 language code for the email, e.g. `en` or `fr`. Only
            present when set.
        emailFormat:
          type: string
          enum:
            - styled
            - plain
          description: The rendering format of the email.
          examples:
            - styled
        lmx:
          type: string
          description: The email body serialized as LMX.
          examples:
            - <Paragraph>Hello, {firstName}!</Paragraph>
        contentRevisionId:
          type:
            - string
            - "null"
          description: The current content revision. Pass this as `expectedRevisionId` on
            your next update.
          examples:
            - clrev1s10n2i3d4e5f6g7h8
        updatedAt:
          type: string
          format: date-time
          examples:
            - 2025-06-29T07:47:39.370Z
        contactPropertiesFallbacks:
          type: object
          description: Fallback values for contact properties. Only present when set.
          additionalProperties:
            type: string
        eventPropertiesFallbacks:
          type: object
          description: Fallback values for event properties. Only present when set.
          additionalProperties:
            type: string
        dataVariablesFallbacks:
          type: object
          description: Fallback values for data variables. Only present when set.
          additionalProperties:
            type: string
        warnings:
          type: array
          description: Non-fatal issues raised while compiling the submitted LMX. Only
            present on update responses when warnings were produced.
          items:
            type: object
            properties:
              rule:
                type: string
              severity:
                type: string
                enum:
                  - warning
              message:
                type: string
              path:
                type: string
            required:
              - rule
              - severity
              - message
      required:
        - id
        - subject
        - previewText
        - fromName
        - fromEmail
        - replyToEmail
        - emailFormat
        - lmx
        - contentRevisionId
        - updatedAt
      examples:
        - id: cle5f7g9h1i3j5k7l9m1n3p5
          campaignId: clc4m6n8p0q2r4s6t8u0v2x4
          subject: Spring product updates
          previewText: See what's new this season
          fromName: Acme Team
          fromEmail: hello
          replyToEmail: support@company.com
          emailFormat: styled
          lmx: <Paragraph>Hello, {firstName}!</Paragraph>
          contentRevisionId: clrev1s10n2i3d4e5f6g7h8
          updatedAt: 2025-06-29T07:47:39.370Z
    EmailMessageFailureResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      examples:
        - message: Email message not found.
    EmailMessagePreviewRequest:
      type: object
      properties:
        emails:
          type: array
          minItems: 1
          items:
            type: string
          description: One or more addresses to send the preview to.
        contactProperties:
          type: object
          additionalProperties:
            type: string
          description: Contact property values to render. Accepted for campaign and
            workflow previews.
          example:
            firstName: Alex
        eventProperties:
          type: object
          additionalProperties:
            type: string
          description: Event property values to render. Accepted for workflow previews only.
          example:
            planName: Pro
        dataVariables:
          type: object
          additionalProperties:
            type: string
          description: Transactional data variables to render. Accepted for transactional
            previews only.
          example:
            loginUrl: https://app.company.com/login
      required:
        - emails
      additionalProperties: false
      examples:
        - emails:
            - alex@company.com
          contactProperties:
            firstName: Alex
          eventProperties:
            planName: Pro
          dataVariables:
            loginUrl: https://app.company.com/login
    EmailMessagePreviewResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the email message the preview was sent for.
          examples:
            - cle5f7g9h1i3j5k7l9m1n3p5
      required:
        - id
      examples:
        - id: cle5f7g9h1i3j5k7l9m1n3p5
    EmailMessageGuardianResponse:
      type: object
      properties:
        errors:
          type: array
          description: Validation errors. These must be resolved before the email can be
            published.
          items:
            $ref: "#/components/schemas/GuardianRule"
        warnings:
          type: array
          description: Validation warnings. These are advisory and do not block publishing.
          items:
            $ref: "#/components/schemas/GuardianRule"
      required:
        - errors
        - warnings
      example:
        errors:
          - rule: missingButtonHrefs
            title: Missing button link
            description: Buttons won't work without href value
            items:
              - label: Click here
          - rule: missingLinkHrefs
            title: Missing text link
            description: Links won't work without href value
            items:
              - label: See more
        warnings: []
    GuardianRule:
      type: object
      properties:
        rule:
          type: string
          description: The identifier of the Guardian rule that fired.
          enum:
            - unsupportedContactProperties
            - missingFallbackContactProperties
            - unsupportedEventProperties
            - missingFallbackEventProperties
            - unsupportedDataVariables
            - invalidCustomDataVariables
            - missingRequiredDataVariables
            - missingButtonHrefs
            - invalidButtonHrefs
            - shortenedYouTubeButtonHrefs
            - missingLinkHrefs
            - invalidLinkHrefs
            - shortenedYouTubeLinkHrefs
            - shortenedYouTubeImageHrefs
            - emailWithoutMailtoButtonHrefs
            - emailWithoutMailtoLinkHrefs
            - emailWithoutMailtoImageHrefs
            - bareArrayNodes
            - missingSocialIconHrefs
        title:
          type: string
          description: A short summary of the rule.
        description:
          type: string
          description: A longer explanation of why the issue matters.
        items:
          type: array
          description: The specific elements that triggered the rule.
          items:
            type: object
            properties:
              label:
                type: string
                description: A human-readable label for the item (for example, link text or a
                  property name).
              codeName:
                type: string
                description: Machine-readable identifier when the rule refers to a property or
                  variable, when applicable.
                example: firstName
            required:
              - label
      required:
        - rule
        - title
        - description
        - items
    CreateUploadRequest:
      type: object
      properties:
        contentType:
          type: string
          description: The MIME type of the file to upload. Supported types are
            `image/jpeg`, `image/png`, `image/gif` and `image/webp`.
          examples:
            - image/png
        contentLength:
          type: integer
          description: The size of the file in bytes. Must be a positive integer no
            greater than 4,000,000 bytes.
          examples:
            - 102400
      required:
        - contentType
        - contentLength
      additionalProperties: false
    CreateUploadResponse:
      type: object
      properties:
        emailAssetId:
          type: string
          examples:
            - cla3s5s7e9t1i3d5f7g9h1j3
          description: The ID of the created asset. Pass this as `emailAssetId` to `POST
            /v1/uploads/{emailAssetId}/complete` once the file has been
            uploaded.
        presignedUrl:
          type: string
          description: The pre-signed URL to upload the file to with an HTTP `PUT`
            request. Send the same `Content-Type` and `Content-Length` used in
            the create request.
          examples:
            - https://loops-assets.s3.amazonaws.com/uploads/cla3s5s7e9t1i3d5f7g9h1j3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...
      required:
        - emailAssetId
        - presignedUrl
      examples:
        - emailAssetId: cla3s5s7e9t1i3d5f7g9h1j3
          presignedUrl: https://loops-assets.s3.amazonaws.com/uploads/cla3s5s7e9t1i3d5f7g9h1j3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...
    CompleteUploadResponse:
      type: object
      properties:
        emailAssetId:
          type: string
          examples:
            - cla3s5s7e9t1i3d5f7g9h1j3
          description: The ID of the created asset.
        finalUrl:
          type: string
          description: The public URL of the uploaded asset.
          examples:
            - https://assets.loops.so/cla3s5s7e9t1i3d5f7g9h1j3/logo.png
      required:
        - emailAssetId
        - finalUrl
      examples:
        - emailAssetId: cla3s5s7e9t1i3d5f7g9h1j3
          finalUrl: https://assets.loops.so/cla3s5s7e9t1i3d5f7g9h1j3/logo.png
    UploadLimitExceededFailureResponse:
      type: object
      properties:
        message:
          type: string
          examples:
            - "Upload limit exceeded: max 50 uploads per 24 hours. Please
              contact support if you need to increase your upload limit."
        maxUploads:
          type: integer
          description: The maximum number of uploads allowed per window.
          examples:
            - 50
        windowHours:
          type: integer
          description: The number of hours in the upload limit window.
          examples:
            - 24
    UploadFailureResponse:
      type: object
      properties:
        message:
          type: string
          examples:
            - Unsupported content type.
        supportedContentTypes:
          type: array
          description: Present when the request was rejected for an unsupported
            `contentType`. Lists the accepted MIME types.
          items:
            type: string
        maxBytes:
          type: integer
          description: Present when the upload exceeds the size limit. The maximum allowed
            size in bytes.
      required:
        - message
      examples:
        - message: Unsupported content type.
          supportedContentTypes:
            - image/jpeg
            - image/png
            - image/gif
            - image/webp
          maxBytes: 4000000
    Pagination:
      type: object
      properties:
        totalResults:
          type: number
          examples:
            - 2
        returnedResults:
          type: number
          examples:
            - 2
        perPage:
          type: number
          examples:
            - 20
        totalPages:
          type: number
          examples:
            - 1
        nextCursor:
          type:
            - string
            - "null"
          examples:
            - null
        nextPage:
          type:
            - string
            - "null"
          examples:
            - null
      required:
        - totalResults
        - returnedResults
        - perPage
        - totalPages
        - nextCursor
        - nextPage
      examples:
        - totalResults: 2
          returnedResults: 2
          perPage: 20
          totalPages: 1
          nextCursor: null
          nextPage: null
    WebhookContactIdentity:
      type: object
      required:
        - id
        - email
        - userId
      properties:
        id:
          type: string
        email:
          type: string
        userId:
          type:
            - string
            - "null"
    WebhookBasePayload:
      type: object
      required:
        - eventName
        - eventTime
        - webhookSchemaVersion
        - contactIdentity
      properties:
        eventName:
          type: string
        eventTime:
          type: integer
          description: Unix timestamp in seconds.
        webhookSchemaVersion:
          type: string
          const: 1.0.0
        contactIdentity:
          $ref: "#/components/schemas/WebhookContactIdentity"
    WebhookContact:
      type: object
      required:
        - id
        - email
        - firstName
        - lastName
        - source
        - subscribed
        - userGroup
        - userId
        - mailingLists
        - optInStatus
      properties:
        id:
          type: string
        email:
          type: string
        firstName:
          type:
            - string
            - "null"
        lastName:
          type:
            - string
            - "null"
        source:
          type: string
        subscribed:
          type: boolean
        userGroup:
          type: string
        userId:
          type:
            - string
            - "null"
        notes:
          type:
            - string
            - "null"
        mailingLists:
          type: object
          description: An object of mailing list IDs and boolean subscription statuses.
          additionalProperties:
            type: boolean
        optInStatus:
          type:
            - string
            - "null"
          description: Double opt-in status.
          enum:
            - accepted
            - pending
            - rejected
            - null
      additionalProperties: true
      description: Full contact object, including custom properties.
    WebhookEmail:
      type: object
      required:
        - id
        - emailMessageId
        - subject
      properties:
        id:
          type: string
          description: The ID of the email.
        emailMessageId:
          type: string
          description: The ID of the sent version of the campaign, workflow or
            transactional email.
        subject:
          type: string
          description: The subject of the email.
    WebhookMailingList:
      type: object
      description: Details of the mailing list.
      required:
        - id
        - name
        - description
        - isPublic
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - "null"
        isPublic:
          type: boolean
    WebhookEmailMetricPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - email
            - sourceType
          properties:
            email:
              $ref: "#/components/schemas/WebhookEmail"
            sourceType:
              type: string
              enum:
                - loop
                - campaign
                - transactional
              description: The type of email this event relates to. Workflow emails use
                `loop`.
            campaignId:
              type: string
              description: The ID of the campaign if `sourceType` is `campaign`.
            loopId:
              type: string
              description: The ID of the workflow if `sourceType` is `loop`.
            transactionalId:
              type: string
              description: The ID of the transactional email if `sourceType` is
                `transactional`.
    WebhookMarketingEmailMetricPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - email
            - sourceType
          properties:
            email:
              $ref: "#/components/schemas/WebhookEmail"
            sourceType:
              type: string
              enum:
                - loop
                - campaign
              description: The type of email this event relates to. Workflow emails use
                `loop`. Not available for transactional emails.
            campaignId:
              type: string
              description: The ID of the campaign if `sourceType` is `campaign`.
            loopId:
              type: string
              description: The ID of the workflow if `sourceType` is `loop`.
    WebhookContactUnsubscribedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: contact.unsubscribed
    WebhookContactCreatedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - eventName
            - contact
          properties:
            eventName:
              type: string
              const: contact.created
            contact:
              $ref: "#/components/schemas/WebhookContact"
    WebhookContactDeletedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: contact.deleted
    WebhookContactMailingListSubscribedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - eventName
            - mailingList
          properties:
            eventName:
              type: string
              const: contact.mailingList.subscribed
            mailingList:
              $ref: "#/components/schemas/WebhookMailingList"
    WebhookContactMailingListUnsubscribedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - eventName
            - mailingList
          properties:
            eventName:
              type: string
              const: contact.mailingList.unsubscribed
            mailingList:
              $ref: "#/components/schemas/WebhookMailingList"
    WebhookTransactionalEmailSentPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - eventName
            - transactionalId
            - email
            - transactionalName
          properties:
            eventName:
              type: string
              const: transactional.email.sent
            transactionalId:
              type: string
            transactionalName:
              type: string
            email:
              $ref: "#/components/schemas/WebhookEmail"
    WebhookCampaignEmailSentPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - eventName
            - campaignId
            - email
            - mailingLists
            - campaignName
          properties:
            eventName:
              type: string
              const: campaign.email.sent
            campaignId:
              type: string
            campaignName:
              type: string
            email:
              $ref: "#/components/schemas/WebhookEmail"
            mailingLists:
              type: array
              description: The mailing list(s) the email was sent to, or an empty array.
              items:
                $ref: "#/components/schemas/WebhookMailingList"
    WebhookLoopEmailSentPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookBasePayload"
        - type: object
          required:
            - eventName
            - loopId
            - email
            - mailingLists
            - loopName
          properties:
            eventName:
              type: string
              const: loop.email.sent
            loopId:
              type: string
              description: The ID of the workflow.
            loopName:
              type: string
              description: The name of the workflow.
            email:
              $ref: "#/components/schemas/WebhookEmail"
            mailingLists:
              type: array
              description: The mailing list(s) the email was sent to, or an empty array.
              items:
                $ref: "#/components/schemas/WebhookMailingList"
    WebhookEmailDeliveredPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookEmailMetricPayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: email.delivered
    WebhookEmailSoftBouncedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookEmailMetricPayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: email.softBounced
    WebhookEmailHardBouncedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookEmailMetricPayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: email.hardBounced
    WebhookEmailClickedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookMarketingEmailMetricPayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: email.clicked
    WebhookEmailUnsubscribedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookMarketingEmailMetricPayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: email.unsubscribed
    WebhookEmailResubscribedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookMarketingEmailMetricPayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: email.resubscribed
    WebhookEmailOpenedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookMarketingEmailMetricPayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: email.opened
    WebhookEmailSpamReportedPayload:
      allOf:
        - $ref: "#/components/schemas/WebhookEmailMetricPayload"
        - type: object
          required:
            - eventName
          properties:
            eventName:
              type: string
              const: email.spamReported
    WebhookTestingTestEventPayload:
      type: object
      required:
        - eventName
        - eventTime
        - message
        - webhookSchemaVersion
      properties:
        eventName:
          type: string
          const: testing.testEvent
        eventTime:
          type: integer
          description: Unix timestamp in seconds.
        message:
          type: string
          const: test
        webhookSchemaVersion:
          type: string
          const: 1.0.0
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
  parameters:
    WebhookId:
      name: webhook-id
      in: header
      required: true
      schema:
        type: string
      description: Unique message ID. Use to deduplicate deliveries.
    WebhookTimestamp:
      name: webhook-timestamp
      in: header
      required: true
      schema:
        type: string
      description: Unix timestamp of when the message was sent.
    WebhookSignature:
      name: webhook-signature
      in: header
      required: true
      schema:
        type: string
      description: HMAC signature for verifying the request. Verify using your
        endpoint signing secret from the Loops dashboard.