hostinger-api-mcp 1.49.0 → 1.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -2
- package/gemini-extension.json +1 -1
- package/package.json +1 -1
- package/server.json +2 -2
- package/src/core/runtime.js +3 -1
- package/src/core/runtime.ts +3 -1
- package/src/core/tools/agency-hosting.js +239 -0
- package/src/core/tools/agency-hosting.ts +239 -0
- package/src/core/tools/all.js +2367 -0
- package/src/core/tools/all.ts +2367 -0
- package/src/core/tools/billing.js +57 -0
- package/src/core/tools/billing.ts +57 -0
- package/src/core/tools/dns.js +50 -0
- package/src/core/tools/dns.ts +50 -0
- package/src/core/tools/domains.js +255 -0
- package/src/core/tools/domains.ts +255 -0
- package/src/core/tools/ecommerce.js +180 -0
- package/src/core/tools/ecommerce.ts +180 -0
- package/src/core/tools/horizons.js +12 -0
- package/src/core/tools/horizons.ts +12 -0
- package/src/core/tools/hosting.js +365 -0
- package/src/core/tools/hosting.ts +365 -0
- package/src/core/tools/mail.js +239 -0
- package/src/core/tools/mail.ts +239 -0
- package/src/core/tools/reach.js +306 -0
- package/src/core/tools/reach.ts +306 -0
- package/src/core/tools/vps.js +432 -0
- package/src/core/tools/vps.ts +432 -0
- package/src/core/tools/wordpress.js +232 -0
- package/src/core/tools/wordpress.ts +232 -0
- package/src/servers/agency-hosting.js +1 -1
- package/src/servers/agency-hosting.ts +1 -1
- package/src/servers/all.js +1 -1
- package/src/servers/all.ts +1 -1
- package/src/servers/billing.js +1 -1
- package/src/servers/billing.ts +1 -1
- package/src/servers/dns.js +1 -1
- package/src/servers/dns.ts +1 -1
- package/src/servers/domains.js +1 -1
- package/src/servers/domains.ts +1 -1
- package/src/servers/ecommerce.js +1 -1
- package/src/servers/ecommerce.ts +1 -1
- package/src/servers/horizons.js +1 -1
- package/src/servers/horizons.ts +1 -1
- package/src/servers/hosting.js +1 -1
- package/src/servers/hosting.ts +1 -1
- package/src/servers/mail.js +1 -1
- package/src/servers/mail.ts +1 -1
- package/src/servers/reach.js +1 -1
- package/src/servers/reach.ts +1 -1
- package/src/servers/vps.js +1 -1
- package/src/servers/vps.ts +1 -1
- package/src/servers/wordpress.js +1 -1
- package/src/servers/wordpress.ts +1 -1
- package/types.d.ts +25 -0
package/src/core/tools/reach.js
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
export default [
|
|
3
3
|
{
|
|
4
4
|
"name": "reach_getAutomationDetailsV1",
|
|
5
|
+
"title": "Get automation details",
|
|
6
|
+
"annotations": {
|
|
7
|
+
"title": "Get automation details",
|
|
8
|
+
"readOnlyHint": true,
|
|
9
|
+
"destructiveHint": false
|
|
10
|
+
},
|
|
5
11
|
"description": "Get a single automation with the counts of contacts that entered it, are moving through it,\nfinished it or failed on the way.\n\nThis describes the automation itself. To see the workflow it runs, use the steps endpoint.",
|
|
6
12
|
"method": "GET",
|
|
7
13
|
"path": "/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}",
|
|
@@ -31,6 +37,12 @@ export default [
|
|
|
31
37
|
},
|
|
32
38
|
{
|
|
33
39
|
"name": "reach_listAutomationsV1",
|
|
40
|
+
"title": "List automations",
|
|
41
|
+
"annotations": {
|
|
42
|
+
"title": "List automations",
|
|
43
|
+
"readOnlyHint": true,
|
|
44
|
+
"destructiveHint": false
|
|
45
|
+
},
|
|
34
46
|
"description": "Get a paginated list of the automations in a profile.\n\nEvery automation comes with the counts of contacts that entered it, are moving through it,\nfinished it or failed on the way. Those counts describe the contact journey and are not\nemail engagement metrics - for opens, clicks and unsubscribes use the campaign statistics\nendpoint instead.",
|
|
35
47
|
"method": "GET",
|
|
36
48
|
"path": "/api/reach/v1/profiles/{profileUuid}/automations",
|
|
@@ -80,6 +92,12 @@ export default [
|
|
|
80
92
|
},
|
|
81
93
|
{
|
|
82
94
|
"name": "reach_listAutomationStepsV1",
|
|
95
|
+
"title": "List automation steps",
|
|
96
|
+
"annotations": {
|
|
97
|
+
"title": "List automation steps",
|
|
98
|
+
"readOnlyHint": true,
|
|
99
|
+
"destructiveHint": false
|
|
100
|
+
},
|
|
83
101
|
"description": "Get the workflow of an automation as a flat list of steps.\n\nThe steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the\nbranches, and use `step_order` to order the steps that share a parent. An automation with no\nsteps yet returns an empty list.",
|
|
84
102
|
"method": "GET",
|
|
85
103
|
"path": "/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps",
|
|
@@ -109,6 +127,12 @@ export default [
|
|
|
109
127
|
},
|
|
110
128
|
{
|
|
111
129
|
"name": "reach_getCampaignDetailsV1",
|
|
130
|
+
"title": "Get campaign details",
|
|
131
|
+
"annotations": {
|
|
132
|
+
"title": "Get campaign details",
|
|
133
|
+
"readOnlyHint": true,
|
|
134
|
+
"destructiveHint": false
|
|
135
|
+
},
|
|
112
136
|
"description": "Get a single campaign with its sender, subject, template reference, targeting and delivery\nprogress.\n\nThis describes how the campaign was set up and how far it has got. For opens, clicks and\nunsubscribes use the campaign statistics endpoint.",
|
|
113
137
|
"method": "GET",
|
|
114
138
|
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}",
|
|
@@ -138,6 +162,12 @@ export default [
|
|
|
138
162
|
},
|
|
139
163
|
{
|
|
140
164
|
"name": "reach_listCampaignsV1",
|
|
165
|
+
"title": "List campaigns",
|
|
166
|
+
"annotations": {
|
|
167
|
+
"title": "List campaigns",
|
|
168
|
+
"readOnlyHint": true,
|
|
169
|
+
"destructiveHint": false
|
|
170
|
+
},
|
|
141
171
|
"description": "Get a paginated list of the campaigns in a profile.\n\nEach campaign carries its headline engagement rates. Filter by status to find drafts,\nscheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the\nstatus `publish`. By default only regular campaigns are returned - pass `type` to get the\nemails sent by automations or the double opt-in confirmations instead.",
|
|
142
172
|
"method": "GET",
|
|
143
173
|
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns",
|
|
@@ -198,6 +228,12 @@ export default [
|
|
|
198
228
|
},
|
|
199
229
|
{
|
|
200
230
|
"name": "reach_getCampaignPerformanceV1",
|
|
231
|
+
"title": "Get campaign performance",
|
|
232
|
+
"annotations": {
|
|
233
|
+
"title": "Get campaign performance",
|
|
234
|
+
"readOnlyHint": true,
|
|
235
|
+
"destructiveHint": false
|
|
236
|
+
},
|
|
201
237
|
"description": "Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the\nmatching rates.\n\nEvery count is unique contacts rather than raw events, so a contact who opens the same email\nfive times is counted once.",
|
|
202
238
|
"method": "GET",
|
|
203
239
|
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics",
|
|
@@ -227,6 +263,13 @@ export default [
|
|
|
227
263
|
},
|
|
228
264
|
{
|
|
229
265
|
"name": "reach_deleteAContactV1",
|
|
266
|
+
"title": "Delete a contact",
|
|
267
|
+
"annotations": {
|
|
268
|
+
"title": "Delete a contact",
|
|
269
|
+
"readOnlyHint": false,
|
|
270
|
+
"destructiveHint": true,
|
|
271
|
+
"idempotentHint": true
|
|
272
|
+
},
|
|
230
273
|
"description": "Delete a contact with the specified UUID.\n\nThis endpoint permanently removes a contact from the email marketing system.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to the\nclient's default profile and cannot delete contacts of any other profile. Use\n`DELETE /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}` instead.",
|
|
231
274
|
"method": "DELETE",
|
|
232
275
|
"path": "/api/reach/v1/contacts/{uuid}",
|
|
@@ -251,6 +294,13 @@ export default [
|
|
|
251
294
|
},
|
|
252
295
|
{
|
|
253
296
|
"name": "reach_deleteAContactFieldV1",
|
|
297
|
+
"title": "Delete a contact field",
|
|
298
|
+
"annotations": {
|
|
299
|
+
"title": "Delete a contact field",
|
|
300
|
+
"readOnlyHint": false,
|
|
301
|
+
"destructiveHint": true,
|
|
302
|
+
"idempotentHint": true
|
|
303
|
+
},
|
|
254
304
|
"description": "Delete a custom contact field.\n\nEvery value contacts hold for the field is deleted with it, and for the choice types so\nare its options. The contacts themselves are not affected.",
|
|
255
305
|
"method": "DELETE",
|
|
256
306
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}",
|
|
@@ -280,6 +330,13 @@ export default [
|
|
|
280
330
|
},
|
|
281
331
|
{
|
|
282
332
|
"name": "reach_updateAContactFieldV1",
|
|
333
|
+
"title": "Update a contact field",
|
|
334
|
+
"annotations": {
|
|
335
|
+
"title": "Update a contact field",
|
|
336
|
+
"readOnlyHint": false,
|
|
337
|
+
"destructiveHint": true,
|
|
338
|
+
"idempotentHint": true
|
|
339
|
+
},
|
|
283
340
|
"description": "Rename a custom contact field and, for the choice types, replace its option set.\n\nOptions carrying a uuid are kept and relabelled, options without one are created, and any\nexisting option left out of the list is deleted along with the values contacts hold for\nit. The field type and slug cannot be changed.",
|
|
284
341
|
"method": "PATCH",
|
|
285
342
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}",
|
|
@@ -335,6 +392,12 @@ export default [
|
|
|
335
392
|
},
|
|
336
393
|
{
|
|
337
394
|
"name": "reach_listContactFieldsV1",
|
|
395
|
+
"title": "List contact fields",
|
|
396
|
+
"annotations": {
|
|
397
|
+
"title": "List contact fields",
|
|
398
|
+
"readOnlyHint": true,
|
|
399
|
+
"destructiveHint": false
|
|
400
|
+
},
|
|
338
401
|
"description": "Get the custom contact fields defined in a profile.\n\nCustom fields let you store your own attributes on contacts. The returned uuids are what\nyou pass to the contact update endpoint to set values, and choice fields also list the\noptions available to pick from.",
|
|
339
402
|
"method": "GET",
|
|
340
403
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts/fields",
|
|
@@ -359,6 +422,12 @@ export default [
|
|
|
359
422
|
},
|
|
360
423
|
{
|
|
361
424
|
"name": "reach_createAContactFieldV1",
|
|
425
|
+
"title": "Create a contact field",
|
|
426
|
+
"annotations": {
|
|
427
|
+
"title": "Create a contact field",
|
|
428
|
+
"readOnlyHint": false,
|
|
429
|
+
"destructiveHint": false
|
|
430
|
+
},
|
|
362
431
|
"description": "Define a new custom contact field in a profile.\n\nThe `slug` is derived from the label and, like the field type, cannot be changed later.\nUse the returned uuid to set values on contacts.",
|
|
363
432
|
"method": "POST",
|
|
364
433
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts/fields",
|
|
@@ -408,6 +477,12 @@ export default [
|
|
|
408
477
|
},
|
|
409
478
|
{
|
|
410
479
|
"name": "reach_listContactGroupsV1",
|
|
480
|
+
"title": "List contact groups",
|
|
481
|
+
"annotations": {
|
|
482
|
+
"title": "List contact groups",
|
|
483
|
+
"readOnlyHint": true,
|
|
484
|
+
"destructiveHint": false
|
|
485
|
+
},
|
|
411
486
|
"description": "Get a list of all contact groups.\n\nThis endpoint returns a list of contact groups that can be used to organize contacts.",
|
|
412
487
|
"method": "GET",
|
|
413
488
|
"path": "/api/reach/v1/contacts/groups",
|
|
@@ -425,6 +500,12 @@ export default [
|
|
|
425
500
|
},
|
|
426
501
|
{
|
|
427
502
|
"name": "reach_listContactsV1",
|
|
503
|
+
"title": "List contacts",
|
|
504
|
+
"annotations": {
|
|
505
|
+
"title": "List contacts",
|
|
506
|
+
"readOnlyHint": true,
|
|
507
|
+
"destructiveHint": false
|
|
508
|
+
},
|
|
428
509
|
"description": "Get a list of contacts, optionally filtered by group and subscription status.\n\nThis endpoint returns a paginated list of contacts with their basic information.\nYou can filter contacts by group UUID and subscription status.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to the\nclient's default profile and cannot list contacts of any other profile. Use\n`GET /api/reach/v1/profiles/{profileUuid}/contacts` instead, which also replaces the\ngroup filter with a tag filter.",
|
|
429
510
|
"method": "GET",
|
|
430
511
|
"path": "/api/reach/v1/contacts",
|
|
@@ -461,6 +542,12 @@ export default [
|
|
|
461
542
|
},
|
|
462
543
|
{
|
|
463
544
|
"name": "reach_createANewContactV1",
|
|
545
|
+
"title": "Create a new contact",
|
|
546
|
+
"annotations": {
|
|
547
|
+
"title": "Create a new contact",
|
|
548
|
+
"readOnlyHint": false,
|
|
549
|
+
"destructiveHint": false
|
|
550
|
+
},
|
|
464
551
|
"description": "Create a new contact in the email marketing system.\n\nThis endpoint allows you to create a new contact with basic information like name, email, and surname.\n\nIf double opt-in is enabled,\nthe contact will be created with a pending status and a confirmation email will be sent.",
|
|
465
552
|
"method": "POST",
|
|
466
553
|
"path": "/api/reach/v1/contacts",
|
|
@@ -509,6 +596,12 @@ export default [
|
|
|
509
596
|
},
|
|
510
597
|
{
|
|
511
598
|
"name": "reach_getContactDetailsV1",
|
|
599
|
+
"title": "Get contact details",
|
|
600
|
+
"annotations": {
|
|
601
|
+
"title": "Get contact details",
|
|
602
|
+
"readOnlyHint": true,
|
|
603
|
+
"destructiveHint": false
|
|
604
|
+
},
|
|
512
605
|
"description": "Get the full details of a single contact.\n\nAlongside the contact's own attributes this returns the tags assigned to it and the\nvalues it holds for the profile's custom contact fields.",
|
|
513
606
|
"method": "GET",
|
|
514
607
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}",
|
|
@@ -538,6 +631,13 @@ export default [
|
|
|
538
631
|
},
|
|
539
632
|
{
|
|
540
633
|
"name": "reach_deleteAProfileContactV1",
|
|
634
|
+
"title": "Delete a profile contact",
|
|
635
|
+
"annotations": {
|
|
636
|
+
"title": "Delete a profile contact",
|
|
637
|
+
"readOnlyHint": false,
|
|
638
|
+
"destructiveHint": true,
|
|
639
|
+
"idempotentHint": true
|
|
640
|
+
},
|
|
541
641
|
"description": "Permanently delete a contact from a profile.\n\nThe contact is removed together with its custom field values and tag assignments.",
|
|
542
642
|
"method": "DELETE",
|
|
543
643
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}",
|
|
@@ -567,6 +667,13 @@ export default [
|
|
|
567
667
|
},
|
|
568
668
|
{
|
|
569
669
|
"name": "reach_updateAContactV1",
|
|
670
|
+
"title": "Update a contact",
|
|
671
|
+
"annotations": {
|
|
672
|
+
"title": "Update a contact",
|
|
673
|
+
"readOnlyHint": false,
|
|
674
|
+
"destructiveHint": true,
|
|
675
|
+
"idempotentHint": true
|
|
676
|
+
},
|
|
570
677
|
"description": "Update a contact's attributes and custom field values.\n\nOnly the properties present in the request body are changed, so a partial body is enough\nto change a single attribute. Sending a property as `null` clears it.\n\nThe response carries the contact's core attributes. Read back its tags, custom field\nvalues, source and note with `GET /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}`.",
|
|
571
678
|
"method": "PATCH",
|
|
572
679
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}",
|
|
@@ -655,6 +762,12 @@ export default [
|
|
|
655
762
|
},
|
|
656
763
|
{
|
|
657
764
|
"name": "reach_createContactsInBulkV1",
|
|
765
|
+
"title": "Create contacts in bulk",
|
|
766
|
+
"annotations": {
|
|
767
|
+
"title": "Create contacts in bulk",
|
|
768
|
+
"readOnlyHint": false,
|
|
769
|
+
"destructiveHint": false
|
|
770
|
+
},
|
|
658
771
|
"description": "Create many contacts in a profile in a single call.\n\nThe contacts are imported in the background, so a success response means the import was\naccepted rather than finished. Contacts whose email already exists in the profile are\nleft as they are. If double opt-in is enabled, new contacts start off pending and are\nsent a confirmation email.",
|
|
659
772
|
"method": "POST",
|
|
660
773
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts/bulk",
|
|
@@ -721,6 +834,12 @@ export default [
|
|
|
721
834
|
},
|
|
722
835
|
{
|
|
723
836
|
"name": "reach_listProfileContactsV1",
|
|
837
|
+
"title": "List profile contacts",
|
|
838
|
+
"annotations": {
|
|
839
|
+
"title": "List profile contacts",
|
|
840
|
+
"readOnlyHint": true,
|
|
841
|
+
"destructiveHint": false
|
|
842
|
+
},
|
|
724
843
|
"description": "Get a paginated list of contacts belonging to a profile.\n\nContacts can be filtered by subscription status, by tag, and by an email search term.\nThe `meta.total` field of the response is the number of contacts matching the filters,\nso calling this endpoint without filters gives the profile's total contact count.",
|
|
725
844
|
"method": "GET",
|
|
726
845
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts",
|
|
@@ -771,6 +890,12 @@ export default [
|
|
|
771
890
|
},
|
|
772
891
|
{
|
|
773
892
|
"name": "reach_createNewContactsV1",
|
|
893
|
+
"title": "Create new contacts",
|
|
894
|
+
"annotations": {
|
|
895
|
+
"title": "Create new contacts",
|
|
896
|
+
"readOnlyHint": false,
|
|
897
|
+
"destructiveHint": false
|
|
898
|
+
},
|
|
774
899
|
"description": "Create a new contact in the email marketing system.\n\nThis endpoint allows you to create a new contact with basic information like name, email, and surname.\n\nIf double opt-in is enabled, the contact will be created with a pending status\nand a confirmation email will be sent.",
|
|
775
900
|
"method": "POST",
|
|
776
901
|
"path": "/api/reach/v1/profiles/{profileUuid}/contacts",
|
|
@@ -824,6 +949,12 @@ export default [
|
|
|
824
949
|
},
|
|
825
950
|
{
|
|
826
951
|
"name": "reach_listSegmentsV1",
|
|
952
|
+
"title": "List segments",
|
|
953
|
+
"annotations": {
|
|
954
|
+
"title": "List segments",
|
|
955
|
+
"readOnlyHint": true,
|
|
956
|
+
"destructiveHint": false
|
|
957
|
+
},
|
|
827
958
|
"description": "Get a list of all contact segments.\n\nThis endpoint returns a list of contact segments that can be used to organize contacts.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to\nthe client's default profile and cannot list the segments of any other profile. Use\n`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.",
|
|
828
959
|
"method": "GET",
|
|
829
960
|
"path": "/api/reach/v1/segmentation/segments",
|
|
@@ -841,6 +972,12 @@ export default [
|
|
|
841
972
|
},
|
|
842
973
|
{
|
|
843
974
|
"name": "reach_createANewContactSegmentV1",
|
|
975
|
+
"title": "Create a new contact segment",
|
|
976
|
+
"annotations": {
|
|
977
|
+
"title": "Create a new contact segment",
|
|
978
|
+
"readOnlyHint": false,
|
|
979
|
+
"destructiveHint": false
|
|
980
|
+
},
|
|
844
981
|
"description": "Create a new contact segment.\n\nThis endpoint allows creating a new contact segment that can be used to organize contacts.\nThe segment can be configured with specific criteria like email, name, subscription status, etc.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to\nthe client's default profile and cannot create segments in any other profile. Use\n`POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.",
|
|
845
982
|
"method": "POST",
|
|
846
983
|
"path": "/api/reach/v1/segmentation/segments",
|
|
@@ -947,6 +1084,12 @@ export default [
|
|
|
947
1084
|
},
|
|
948
1085
|
{
|
|
949
1086
|
"name": "reach_countProfileSegmentContactsV1",
|
|
1087
|
+
"title": "Count profile segment contacts",
|
|
1088
|
+
"annotations": {
|
|
1089
|
+
"title": "Count profile segment contacts",
|
|
1090
|
+
"readOnlyHint": true,
|
|
1091
|
+
"destructiveHint": false
|
|
1092
|
+
},
|
|
950
1093
|
"description": "Count the contacts currently matching a segment without listing them.\n\nCheaper than paging through the segment contacts endpoint when only the size is needed.",
|
|
951
1094
|
"method": "GET",
|
|
952
1095
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count",
|
|
@@ -976,6 +1119,12 @@ export default [
|
|
|
976
1119
|
},
|
|
977
1120
|
{
|
|
978
1121
|
"name": "reach_listProfileSegmentContactsV1",
|
|
1122
|
+
"title": "List profile segment contacts",
|
|
1123
|
+
"annotations": {
|
|
1124
|
+
"title": "List profile segment contacts",
|
|
1125
|
+
"readOnlyHint": true,
|
|
1126
|
+
"destructiveHint": false
|
|
1127
|
+
},
|
|
979
1128
|
"description": "Retrieve contacts associated with a specific segment for a given profile.\n\nThis endpoint allows you to fetch and filter contacts that belong to a particular segment,\nidentified by its UUID, scoped to a specific profile.",
|
|
980
1129
|
"method": "GET",
|
|
981
1130
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts",
|
|
@@ -1013,6 +1162,12 @@ export default [
|
|
|
1013
1162
|
},
|
|
1014
1163
|
{
|
|
1015
1164
|
"name": "reach_getProfileSegmentDetailsV1",
|
|
1165
|
+
"title": "Get profile segment details",
|
|
1166
|
+
"annotations": {
|
|
1167
|
+
"title": "Get profile segment details",
|
|
1168
|
+
"readOnlyHint": true,
|
|
1169
|
+
"destructiveHint": false
|
|
1170
|
+
},
|
|
1016
1171
|
"description": "Get a single segment of a profile, including the conditions that define it.\n\nTo retrieve the contacts currently matching those conditions, use the segment contacts\nendpoint instead.",
|
|
1017
1172
|
"method": "GET",
|
|
1018
1173
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
@@ -1042,6 +1197,13 @@ export default [
|
|
|
1042
1197
|
},
|
|
1043
1198
|
{
|
|
1044
1199
|
"name": "reach_updateAProfileSegmentV1",
|
|
1200
|
+
"title": "Update a profile segment",
|
|
1201
|
+
"annotations": {
|
|
1202
|
+
"title": "Update a profile segment",
|
|
1203
|
+
"readOnlyHint": false,
|
|
1204
|
+
"destructiveHint": true,
|
|
1205
|
+
"idempotentHint": true
|
|
1206
|
+
},
|
|
1045
1207
|
"description": "Rename a segment and/or replace the conditions that define it.\n\n`name` is always required. Omit `conditions` to rename without touching the conditions;\nsupply them and they replace the existing set entirely rather than being merged into it.\nContacts are never modified, but which of them match the segment can change immediately.",
|
|
1046
1208
|
"method": "PUT",
|
|
1047
1209
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
@@ -1139,6 +1301,13 @@ export default [
|
|
|
1139
1301
|
},
|
|
1140
1302
|
{
|
|
1141
1303
|
"name": "reach_deleteAProfileSegmentV1",
|
|
1304
|
+
"title": "Delete a profile segment",
|
|
1305
|
+
"annotations": {
|
|
1306
|
+
"title": "Delete a profile segment",
|
|
1307
|
+
"readOnlyHint": false,
|
|
1308
|
+
"destructiveHint": true,
|
|
1309
|
+
"idempotentHint": true
|
|
1310
|
+
},
|
|
1142
1311
|
"description": "Delete a segment.\n\nOnly the segment definition is removed. The contacts that matched it are left untouched.",
|
|
1143
1312
|
"method": "DELETE",
|
|
1144
1313
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
@@ -1168,6 +1337,12 @@ export default [
|
|
|
1168
1337
|
},
|
|
1169
1338
|
{
|
|
1170
1339
|
"name": "reach_listSegmentFilterAttributesV1",
|
|
1340
|
+
"title": "List segment filter attributes",
|
|
1341
|
+
"annotations": {
|
|
1342
|
+
"title": "List segment filter attributes",
|
|
1343
|
+
"readOnlyHint": true,
|
|
1344
|
+
"destructiveHint": false
|
|
1345
|
+
},
|
|
1171
1346
|
"description": "List every attribute a segment condition can filter on, with the operators each attribute\naccepts, the value format they expect and, where the value is constrained, the allowed\nvalues.\n\nThe list is profile specific: it includes the profile's custom contact fields, its tags and\nits 20 most recently published campaigns, so the valid attributes cannot be hardcoded. Read\nit before creating or updating a segment to discover the valid `attribute`, `operator` and\n`value` combinations.",
|
|
1172
1347
|
"method": "GET",
|
|
1173
1348
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/filters/attributes",
|
|
@@ -1192,6 +1367,12 @@ export default [
|
|
|
1192
1367
|
},
|
|
1193
1368
|
{
|
|
1194
1369
|
"name": "reach_previewContactsMatchingConditionsV1",
|
|
1370
|
+
"title": "Preview contacts matching conditions",
|
|
1371
|
+
"annotations": {
|
|
1372
|
+
"title": "Preview contacts matching conditions",
|
|
1373
|
+
"readOnlyHint": true,
|
|
1374
|
+
"destructiveHint": false
|
|
1375
|
+
},
|
|
1195
1376
|
"description": "Preview the contacts matching a set of conditions without saving a segment.\n\nThe body is the same set of conditions accepted when creating or updating a segment, so this\nis how to check who a filter reaches, and how many, before persisting it. Nothing is stored\nand no contact is modified.\n\nCall the segment filter attributes endpoint first to discover the valid `attribute`,\n`operator` and `value` combinations.",
|
|
1196
1377
|
"method": "POST",
|
|
1197
1378
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/filters/contacts",
|
|
@@ -1312,6 +1493,12 @@ export default [
|
|
|
1312
1493
|
},
|
|
1313
1494
|
{
|
|
1314
1495
|
"name": "reach_listProfileSegmentsV1",
|
|
1496
|
+
"title": "List profile segments",
|
|
1497
|
+
"annotations": {
|
|
1498
|
+
"title": "List profile segments",
|
|
1499
|
+
"readOnlyHint": true,
|
|
1500
|
+
"destructiveHint": false
|
|
1501
|
+
},
|
|
1315
1502
|
"description": "Get a paginated list of the segments defined in a profile.\n\nEach entry carries the number of contacts currently matching it, which is recalculated on\nread rather than stored. Use `count_type` to count either every matching contact or only\nthe subscribed ones.",
|
|
1316
1503
|
"method": "GET",
|
|
1317
1504
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments",
|
|
@@ -1352,6 +1539,12 @@ export default [
|
|
|
1352
1539
|
},
|
|
1353
1540
|
{
|
|
1354
1541
|
"name": "reach_createAProfileSegmentV1",
|
|
1542
|
+
"title": "Create a profile segment",
|
|
1543
|
+
"annotations": {
|
|
1544
|
+
"title": "Create a profile segment",
|
|
1545
|
+
"readOnlyHint": false,
|
|
1546
|
+
"destructiveHint": false
|
|
1547
|
+
},
|
|
1355
1548
|
"description": "Create a segment in a profile.\n\nA segment is a saved set of conditions rather than a fixed list, so its membership changes\nas contacts change. Creating one does not modify any contact.",
|
|
1356
1549
|
"method": "POST",
|
|
1357
1550
|
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments",
|
|
@@ -1446,6 +1639,12 @@ export default [
|
|
|
1446
1639
|
},
|
|
1447
1640
|
{
|
|
1448
1641
|
"name": "reach_listSegmentContactsV1",
|
|
1642
|
+
"title": "List segment contacts",
|
|
1643
|
+
"annotations": {
|
|
1644
|
+
"title": "List segment contacts",
|
|
1645
|
+
"readOnlyHint": true,
|
|
1646
|
+
"destructiveHint": false
|
|
1647
|
+
},
|
|
1449
1648
|
"description": "Retrieve contacts associated with a specific segment.\n\nThis endpoint allows you to fetch and filter contacts that belong to a particular segment,\nidentified by its UUID.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to\nthe client's default profile and cannot read segments of any other profile. Use\n`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts` instead.",
|
|
1450
1649
|
"method": "GET",
|
|
1451
1650
|
"path": "/api/reach/v1/segmentation/segments/{segmentUuid}/contacts",
|
|
@@ -1478,6 +1677,12 @@ export default [
|
|
|
1478
1677
|
},
|
|
1479
1678
|
{
|
|
1480
1679
|
"name": "reach_getSegmentDetailsV1",
|
|
1680
|
+
"title": "Get segment details",
|
|
1681
|
+
"annotations": {
|
|
1682
|
+
"title": "Get segment details",
|
|
1683
|
+
"readOnlyHint": true,
|
|
1684
|
+
"destructiveHint": false
|
|
1685
|
+
},
|
|
1481
1686
|
"description": "Get details of a specific segment.\n\nThis endpoint retrieves information about a single segment identified by UUID.\nSegments are used to organize and group contacts based on specific criteria.\n\n**Deprecated.** This endpoint cannot target a profile, so it always falls back to\nthe client's default profile and cannot read segments of any other profile. Use\n`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}` instead.",
|
|
1482
1687
|
"method": "GET",
|
|
1483
1688
|
"path": "/api/reach/v1/segmentation/segments/{segmentUuid}",
|
|
@@ -1502,6 +1707,12 @@ export default [
|
|
|
1502
1707
|
},
|
|
1503
1708
|
{
|
|
1504
1709
|
"name": "reach_assignAContactToATagV1",
|
|
1710
|
+
"title": "Assign a contact to a tag",
|
|
1711
|
+
"annotations": {
|
|
1712
|
+
"title": "Assign a contact to a tag",
|
|
1713
|
+
"readOnlyHint": false,
|
|
1714
|
+
"destructiveHint": false
|
|
1715
|
+
},
|
|
1505
1716
|
"description": "Assign a tag to a single contact.\n\nUnlike the bulk endpoint this is applied immediately rather than queued. Assigning a tag\nthe contact already carries succeeds without duplicating it.",
|
|
1506
1717
|
"method": "POST",
|
|
1507
1718
|
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
@@ -1536,6 +1747,13 @@ export default [
|
|
|
1536
1747
|
},
|
|
1537
1748
|
{
|
|
1538
1749
|
"name": "reach_removeAContactFromATagV1",
|
|
1750
|
+
"title": "Remove a contact from a tag",
|
|
1751
|
+
"annotations": {
|
|
1752
|
+
"title": "Remove a contact from a tag",
|
|
1753
|
+
"readOnlyHint": false,
|
|
1754
|
+
"destructiveHint": true,
|
|
1755
|
+
"idempotentHint": true
|
|
1756
|
+
},
|
|
1539
1757
|
"description": "Remove a tag from a single contact.\n\nUnlike the bulk endpoint this is applied immediately rather than queued. Neither the tag\nnor the contact is deleted.",
|
|
1540
1758
|
"method": "DELETE",
|
|
1541
1759
|
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
@@ -1570,6 +1788,12 @@ export default [
|
|
|
1570
1788
|
},
|
|
1571
1789
|
{
|
|
1572
1790
|
"name": "reach_assignContactsToATagV1",
|
|
1791
|
+
"title": "Assign contacts to a tag",
|
|
1792
|
+
"annotations": {
|
|
1793
|
+
"title": "Assign contacts to a tag",
|
|
1794
|
+
"readOnlyHint": false,
|
|
1795
|
+
"destructiveHint": false
|
|
1796
|
+
},
|
|
1573
1797
|
"description": "Assign a tag to many contacts at once.\n\nPass `contact_uuids` to target specific contacts, or `all_contacts` to target every contact\nin the profile. The work is queued, so a success response means it was accepted rather than\nfinished. Contacts that already carry the tag are left alone.",
|
|
1574
1798
|
"method": "POST",
|
|
1575
1799
|
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
@@ -1611,6 +1835,13 @@ export default [
|
|
|
1611
1835
|
},
|
|
1612
1836
|
{
|
|
1613
1837
|
"name": "reach_removeContactsFromATagV1",
|
|
1838
|
+
"title": "Remove contacts from a tag",
|
|
1839
|
+
"annotations": {
|
|
1840
|
+
"title": "Remove contacts from a tag",
|
|
1841
|
+
"readOnlyHint": false,
|
|
1842
|
+
"destructiveHint": true,
|
|
1843
|
+
"idempotentHint": true
|
|
1844
|
+
},
|
|
1614
1845
|
"description": "Remove a tag from many contacts at once.\n\nPass `contact_uuids` to target specific contacts, or `all_contacts` to target every contact\nin the profile. The work is queued, so a success response means it was accepted rather than\nfinished. The tag itself and the contacts are not deleted.",
|
|
1615
1846
|
"method": "DELETE",
|
|
1616
1847
|
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
@@ -1640,6 +1871,13 @@ export default [
|
|
|
1640
1871
|
},
|
|
1641
1872
|
{
|
|
1642
1873
|
"name": "reach_deleteATagV1",
|
|
1874
|
+
"title": "Delete a tag",
|
|
1875
|
+
"annotations": {
|
|
1876
|
+
"title": "Delete a tag",
|
|
1877
|
+
"readOnlyHint": false,
|
|
1878
|
+
"destructiveHint": true,
|
|
1879
|
+
"idempotentHint": true
|
|
1880
|
+
},
|
|
1643
1881
|
"description": "Delete a tag and remove it from every contact carrying it.\n\nThe contacts themselves are not deleted. This is idempotent: deleting a tag that does not\nexist in the profile still succeeds.",
|
|
1644
1882
|
"method": "DELETE",
|
|
1645
1883
|
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
@@ -1669,6 +1907,13 @@ export default [
|
|
|
1669
1907
|
},
|
|
1670
1908
|
{
|
|
1671
1909
|
"name": "reach_renameATagV1",
|
|
1910
|
+
"title": "Rename a tag",
|
|
1911
|
+
"annotations": {
|
|
1912
|
+
"title": "Rename a tag",
|
|
1913
|
+
"readOnlyHint": false,
|
|
1914
|
+
"destructiveHint": true,
|
|
1915
|
+
"idempotentHint": true
|
|
1916
|
+
},
|
|
1672
1917
|
"description": "Rename a tag.\n\nThe contacts assigned to the tag are unaffected. Names are unique within a profile, so\nrenaming a tag to a name that is already taken is rejected.",
|
|
1673
1918
|
"method": "PATCH",
|
|
1674
1919
|
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
@@ -1703,6 +1948,12 @@ export default [
|
|
|
1703
1948
|
},
|
|
1704
1949
|
{
|
|
1705
1950
|
"name": "reach_listProfileTagsV1",
|
|
1951
|
+
"title": "List profile tags",
|
|
1952
|
+
"annotations": {
|
|
1953
|
+
"title": "List profile tags",
|
|
1954
|
+
"readOnlyHint": true,
|
|
1955
|
+
"destructiveHint": false
|
|
1956
|
+
},
|
|
1706
1957
|
"description": "Get all tags defined in a profile.\n\nTags are the way contacts are grouped in Reach, and can be used to filter the contact\nlist or to build segments.",
|
|
1707
1958
|
"method": "GET",
|
|
1708
1959
|
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
@@ -1727,6 +1978,12 @@ export default [
|
|
|
1727
1978
|
},
|
|
1728
1979
|
{
|
|
1729
1980
|
"name": "reach_createOrFindTagsV1",
|
|
1981
|
+
"title": "Create or find tags",
|
|
1982
|
+
"annotations": {
|
|
1983
|
+
"title": "Create or find tags",
|
|
1984
|
+
"readOnlyHint": false,
|
|
1985
|
+
"destructiveHint": false
|
|
1986
|
+
},
|
|
1730
1987
|
"description": "Create tags in a profile.\n\nNames that already exist in the profile are not duplicated: the existing tag is returned\ninstead, so the call is safe to repeat. Every tag in the request is returned, whether it\nwas created now or already existed.",
|
|
1731
1988
|
"method": "POST",
|
|
1732
1989
|
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
@@ -1760,6 +2017,12 @@ export default [
|
|
|
1760
2017
|
},
|
|
1761
2018
|
{
|
|
1762
2019
|
"name": "reach_getFormDetailsV1",
|
|
2020
|
+
"title": "Get form details",
|
|
2021
|
+
"annotations": {
|
|
2022
|
+
"title": "Get form details",
|
|
2023
|
+
"readOnlyHint": true,
|
|
2024
|
+
"destructiveHint": false
|
|
2025
|
+
},
|
|
1763
2026
|
"description": "Get a single form with the URL of its hosted template and the tags it applies to the contacts\nit captures.\n\nThere is no ready-made embed snippet in the response - either serve the template HTML yourself\nor build your own embed around the form uuid.",
|
|
1764
2027
|
"method": "GET",
|
|
1765
2028
|
"path": "/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}",
|
|
@@ -1789,6 +2052,13 @@ export default [
|
|
|
1789
2052
|
},
|
|
1790
2053
|
{
|
|
1791
2054
|
"name": "reach_deleteFormV1",
|
|
2055
|
+
"title": "Delete form",
|
|
2056
|
+
"annotations": {
|
|
2057
|
+
"title": "Delete form",
|
|
2058
|
+
"readOnlyHint": false,
|
|
2059
|
+
"destructiveHint": true,
|
|
2060
|
+
"idempotentHint": true
|
|
2061
|
+
},
|
|
1792
2062
|
"description": "Permanently delete a form together with its template.\n\nA form that has already captured submissions cannot be deleted, so that the contacts it collected\nare never silently discarded - pause the form instead to stop it collecting new ones. Views alone\ndo not block deletion.",
|
|
1793
2063
|
"method": "DELETE",
|
|
1794
2064
|
"path": "/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}",
|
|
@@ -1818,6 +2088,12 @@ export default [
|
|
|
1818
2088
|
},
|
|
1819
2089
|
{
|
|
1820
2090
|
"name": "reach_listFormsV1",
|
|
2091
|
+
"title": "List forms",
|
|
2092
|
+
"annotations": {
|
|
2093
|
+
"title": "List forms",
|
|
2094
|
+
"readOnlyHint": true,
|
|
2095
|
+
"destructiveHint": false
|
|
2096
|
+
},
|
|
1821
2097
|
"description": "Get a paginated list of the signup forms in a profile.\n\nEach form carries a reference to the template that renders it. Get the form details for a\ndirectly usable template URL and for the tags the form puts on the contacts it captures.",
|
|
1822
2098
|
"method": "GET",
|
|
1823
2099
|
"path": "/api/reach/v1/profiles/{profileUuid}/forms",
|
|
@@ -1850,6 +2126,12 @@ export default [
|
|
|
1850
2126
|
},
|
|
1851
2127
|
{
|
|
1852
2128
|
"name": "reach_getProfileDomainDNSStatusV1",
|
|
2129
|
+
"title": "Get profile domain DNS status",
|
|
2130
|
+
"annotations": {
|
|
2131
|
+
"title": "Get profile domain DNS status",
|
|
2132
|
+
"readOnlyHint": true,
|
|
2133
|
+
"destructiveHint": false
|
|
2134
|
+
},
|
|
1853
2135
|
"description": "Retrieve the DNS configuration status for a profile's domain.\n\nThis endpoint reports the state of MX, SPF, DKIM and DMARC records, including the\nactual records found and the suggested records required for correct email delivery.",
|
|
1854
2136
|
"method": "GET",
|
|
1855
2137
|
"path": "/api/reach/v1/profiles/{profileUuid}/domains/dns-status",
|
|
@@ -1874,6 +2156,12 @@ export default [
|
|
|
1874
2156
|
},
|
|
1875
2157
|
{
|
|
1876
2158
|
"name": "reach_getConnectedSendingDomainV1",
|
|
2159
|
+
"title": "Get connected sending domain",
|
|
2160
|
+
"annotations": {
|
|
2161
|
+
"title": "Get connected sending domain",
|
|
2162
|
+
"readOnlyHint": true,
|
|
2163
|
+
"destructiveHint": false
|
|
2164
|
+
},
|
|
1877
2165
|
"description": "Get the sending domain connected to the profile, its verification status and any suspended\nsender addresses.\n\nCampaigns only go out once a domain is connected and active, so this is the cheapest way to\ncheck that precondition before building one. A profile with no domain connected returns the\nsame shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records\nbehind the status, use the DNS status endpoint.",
|
|
1878
2166
|
"method": "GET",
|
|
1879
2167
|
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
@@ -1898,6 +2186,12 @@ export default [
|
|
|
1898
2186
|
},
|
|
1899
2187
|
{
|
|
1900
2188
|
"name": "reach_listPlanFeatureAccessV1",
|
|
2189
|
+
"title": "List plan feature access",
|
|
2190
|
+
"annotations": {
|
|
2191
|
+
"title": "List plan feature access",
|
|
2192
|
+
"readOnlyHint": true,
|
|
2193
|
+
"destructiveHint": false
|
|
2194
|
+
},
|
|
1901
2195
|
"description": "List which plan features the profile can use.\n\nThis is the feature lock matrix, not a usage quota. `available` means the feature can be\nused right now and `locked` means it is not part of the base plan, so an upgrade is needed.\nFor remaining emails, recipients and AI credits use the limits endpoint instead.\n\nWorth checking before building something that cannot be activated afterwards, such as an\nautomation on a plan without automation activation.",
|
|
1902
2196
|
"method": "GET",
|
|
1903
2197
|
"path": "/api/reach/v1/profiles/{profileUuid}/features",
|
|
@@ -1922,6 +2216,12 @@ export default [
|
|
|
1922
2216
|
},
|
|
1923
2217
|
{
|
|
1924
2218
|
"name": "reach_getRemainingPlanLimitsV1",
|
|
2219
|
+
"title": "Get remaining plan limits",
|
|
2220
|
+
"annotations": {
|
|
2221
|
+
"title": "Get remaining plan limits",
|
|
2222
|
+
"readOnlyHint": true,
|
|
2223
|
+
"destructiveHint": false
|
|
2224
|
+
},
|
|
1925
2225
|
"description": "Get how much of the plan is left for the current period.\n\nTwo things to keep in mind before you build alerting on this. The period is a calendar month\nrather than a billing anniversary, so the counters reset on the 1st no matter when the\nsubscription started. And usage is tracked per order, so every profile on the same order shares\none pool and reports the same numbers here. Only the current period is available, past usage is\nnot kept.",
|
|
1926
2226
|
"method": "GET",
|
|
1927
2227
|
"path": "/api/reach/v1/profiles/{profileUuid}/limits",
|
|
@@ -1946,6 +2246,12 @@ export default [
|
|
|
1946
2246
|
},
|
|
1947
2247
|
{
|
|
1948
2248
|
"name": "reach_listProfilesV1",
|
|
2249
|
+
"title": "List Profiles",
|
|
2250
|
+
"annotations": {
|
|
2251
|
+
"title": "List Profiles",
|
|
2252
|
+
"readOnlyHint": true,
|
|
2253
|
+
"destructiveHint": false
|
|
2254
|
+
},
|
|
1949
2255
|
"description": "This endpoint returns all profiles available to the client, including their basic information.",
|
|
1950
2256
|
"method": "GET",
|
|
1951
2257
|
"path": "/api/reach/v1/profiles",
|