hostinger-api-mcp 1.36.0 → 1.38.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 +81 -2
- package/gemini-extension.json +1 -1
- package/package.json +1 -1
- package/server.json +2 -2
- package/src/core/runtime.js +1 -1
- package/src/core/runtime.ts +1 -1
- package/src/core/tools/all.js +232 -0
- package/src/core/tools/all.ts +232 -0
- package/src/core/tools/reach.js +232 -0
- package/src/core/tools/reach.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 +171 -0
package/README.md
CHANGED
|
@@ -69,7 +69,7 @@ pnpm update -g hostinger-api-mcp
|
|
|
69
69
|
|
|
70
70
|
This package installs the following MCP server commands:
|
|
71
71
|
|
|
72
|
-
- `hostinger-api-mcp` — unified server with every tool (
|
|
72
|
+
- `hostinger-api-mcp` — unified server with every tool (330 total)
|
|
73
73
|
- `hostinger-agency-hosting-mcp` — 27 tools for agency-hosting
|
|
74
74
|
- `hostinger-billing-mcp` — 9 tools for billing
|
|
75
75
|
- `hostinger-dns-mcp` — 8 tools for dns
|
|
@@ -78,7 +78,7 @@ This package installs the following MCP server commands:
|
|
|
78
78
|
- `hostinger-horizons-mcp` — 2 tools for horizons
|
|
79
79
|
- `hostinger-hosting-mcp` — 50 tools for hosting
|
|
80
80
|
- `hostinger-mail-mcp` — 38 tools for mail
|
|
81
|
-
- `hostinger-reach-mcp` —
|
|
81
|
+
- `hostinger-reach-mcp` — 45 tools for reach
|
|
82
82
|
- `hostinger-vps-mcp` — 62 tools for vps
|
|
83
83
|
- `hostinger-wordpress-mcp` — 35 tools for wordpress
|
|
84
84
|
|
|
@@ -2240,6 +2240,40 @@ steps yet returns an empty list.
|
|
|
2240
2240
|
- **Method**: `GET`
|
|
2241
2241
|
- **Path**: `/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps`
|
|
2242
2242
|
|
|
2243
|
+
#### reach_getCampaignDetailsV1
|
|
2244
|
+
|
|
2245
|
+
Get a single campaign with its sender, subject, template reference, targeting and delivery
|
|
2246
|
+
progress.
|
|
2247
|
+
|
|
2248
|
+
This describes how the campaign was set up and how far it has got. For opens, clicks and
|
|
2249
|
+
unsubscribes use the campaign statistics endpoint.
|
|
2250
|
+
|
|
2251
|
+
- **Method**: `GET`
|
|
2252
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}`
|
|
2253
|
+
|
|
2254
|
+
#### reach_listCampaignsV1
|
|
2255
|
+
|
|
2256
|
+
Get a paginated list of the campaigns in a profile.
|
|
2257
|
+
|
|
2258
|
+
Each campaign carries its headline engagement rates. Filter by status to find drafts,
|
|
2259
|
+
scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the
|
|
2260
|
+
status `publish`. By default only regular campaigns are returned - pass `type` to get the
|
|
2261
|
+
emails sent by automations or the double opt-in confirmations instead.
|
|
2262
|
+
|
|
2263
|
+
- **Method**: `GET`
|
|
2264
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/campaigns`
|
|
2265
|
+
|
|
2266
|
+
#### reach_getCampaignPerformanceV1
|
|
2267
|
+
|
|
2268
|
+
Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the
|
|
2269
|
+
matching rates.
|
|
2270
|
+
|
|
2271
|
+
Every count is unique contacts rather than raw events, so a contact who opens the same email
|
|
2272
|
+
five times is counted once.
|
|
2273
|
+
|
|
2274
|
+
- **Method**: `GET`
|
|
2275
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics`
|
|
2276
|
+
|
|
2243
2277
|
#### reach_deleteAContactV1
|
|
2244
2278
|
|
|
2245
2279
|
Delete a contact with the specified UUID.
|
|
@@ -2606,6 +2640,38 @@ was created now or already existed.
|
|
|
2606
2640
|
- **Method**: `POST`
|
|
2607
2641
|
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags`
|
|
2608
2642
|
|
|
2643
|
+
#### reach_getFormDetailsV1
|
|
2644
|
+
|
|
2645
|
+
Get a single form with the URL of its hosted template and the tags it applies to the contacts
|
|
2646
|
+
it captures.
|
|
2647
|
+
|
|
2648
|
+
There is no ready-made embed snippet in the response - either serve the template HTML yourself
|
|
2649
|
+
or build your own embed around the form uuid.
|
|
2650
|
+
|
|
2651
|
+
- **Method**: `GET`
|
|
2652
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
2653
|
+
|
|
2654
|
+
#### reach_deleteFormV1
|
|
2655
|
+
|
|
2656
|
+
Permanently delete a form together with its template.
|
|
2657
|
+
|
|
2658
|
+
A form that has already captured submissions cannot be deleted, so that the contacts it collected
|
|
2659
|
+
are never silently discarded - pause the form instead to stop it collecting new ones. Views alone
|
|
2660
|
+
do not block deletion.
|
|
2661
|
+
|
|
2662
|
+
- **Method**: `DELETE`
|
|
2663
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
2664
|
+
|
|
2665
|
+
#### reach_listFormsV1
|
|
2666
|
+
|
|
2667
|
+
Get a paginated list of the signup forms in a profile.
|
|
2668
|
+
|
|
2669
|
+
Each form carries a reference to the template that renders it. Get the form details for a
|
|
2670
|
+
directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
2671
|
+
|
|
2672
|
+
- **Method**: `GET`
|
|
2673
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/forms`
|
|
2674
|
+
|
|
2609
2675
|
#### reach_getProfileDomainDNSStatusV1
|
|
2610
2676
|
|
|
2611
2677
|
Retrieve the DNS configuration status for a profile's domain.
|
|
@@ -2616,6 +2682,19 @@ actual records found and the suggested records required for correct email delive
|
|
|
2616
2682
|
- **Method**: `GET`
|
|
2617
2683
|
- **Path**: `/api/reach/v1/profiles/{profileUuid}/domains/dns-status`
|
|
2618
2684
|
|
|
2685
|
+
#### reach_getRemainingPlanLimitsV1
|
|
2686
|
+
|
|
2687
|
+
Get how much of the plan is left for the current period.
|
|
2688
|
+
|
|
2689
|
+
Two things to keep in mind before you build alerting on this. The period is a calendar month
|
|
2690
|
+
rather than a billing anniversary, so the counters reset on the 1st no matter when the
|
|
2691
|
+
subscription started. And usage is tracked per order, so every profile on the same order shares
|
|
2692
|
+
one pool and reports the same numbers here. Only the current period is available, past usage is
|
|
2693
|
+
not kept.
|
|
2694
|
+
|
|
2695
|
+
- **Method**: `GET`
|
|
2696
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/limits`
|
|
2697
|
+
|
|
2619
2698
|
#### reach_listProfilesV1
|
|
2620
2699
|
|
|
2621
2700
|
This endpoint returns all profiles available to the client, including their basic information.
|
package/gemini-extension.json
CHANGED
package/package.json
CHANGED
package/server.json
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
"url": "https://github.com/hostinger/api-mcp-server",
|
|
7
7
|
"source": "github"
|
|
8
8
|
},
|
|
9
|
-
"version": "1.
|
|
9
|
+
"version": "1.38.0",
|
|
10
10
|
"packages": [
|
|
11
11
|
{
|
|
12
12
|
"registryType": "npm",
|
|
13
13
|
"identifier": "hostinger-api-mcp",
|
|
14
|
-
"version": "1.
|
|
14
|
+
"version": "1.38.0",
|
|
15
15
|
"transport": {
|
|
16
16
|
"type": "stdio"
|
|
17
17
|
},
|
package/src/core/runtime.js
CHANGED
package/src/core/runtime.ts
CHANGED
package/src/core/tools/all.js
CHANGED
|
@@ -6507,6 +6507,124 @@ export default [
|
|
|
6507
6507
|
],
|
|
6508
6508
|
"group": "reach"
|
|
6509
6509
|
},
|
|
6510
|
+
{
|
|
6511
|
+
"name": "reach_getCampaignDetailsV1",
|
|
6512
|
+
"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.",
|
|
6513
|
+
"method": "GET",
|
|
6514
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}",
|
|
6515
|
+
"inputSchema": {
|
|
6516
|
+
"type": "object",
|
|
6517
|
+
"properties": {
|
|
6518
|
+
"profileUuid": {
|
|
6519
|
+
"type": "string",
|
|
6520
|
+
"description": "Profile uuid parameter"
|
|
6521
|
+
},
|
|
6522
|
+
"campaignUuid": {
|
|
6523
|
+
"type": "string",
|
|
6524
|
+
"description": "Campaign uuid parameter"
|
|
6525
|
+
}
|
|
6526
|
+
},
|
|
6527
|
+
"required": [
|
|
6528
|
+
"profileUuid",
|
|
6529
|
+
"campaignUuid"
|
|
6530
|
+
]
|
|
6531
|
+
},
|
|
6532
|
+
"security": [
|
|
6533
|
+
{
|
|
6534
|
+
"apiToken": []
|
|
6535
|
+
}
|
|
6536
|
+
],
|
|
6537
|
+
"group": "reach"
|
|
6538
|
+
},
|
|
6539
|
+
{
|
|
6540
|
+
"name": "reach_listCampaignsV1",
|
|
6541
|
+
"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.",
|
|
6542
|
+
"method": "GET",
|
|
6543
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns",
|
|
6544
|
+
"inputSchema": {
|
|
6545
|
+
"type": "object",
|
|
6546
|
+
"properties": {
|
|
6547
|
+
"profileUuid": {
|
|
6548
|
+
"type": "string",
|
|
6549
|
+
"description": "Profile uuid parameter"
|
|
6550
|
+
},
|
|
6551
|
+
"status": {
|
|
6552
|
+
"type": "string",
|
|
6553
|
+
"description": "Filter campaigns by status.\n\nA fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can\nbe neither paused nor archived.",
|
|
6554
|
+
"enum": [
|
|
6555
|
+
"draft",
|
|
6556
|
+
"scheduled",
|
|
6557
|
+
"sending",
|
|
6558
|
+
"publish",
|
|
6559
|
+
"failed"
|
|
6560
|
+
]
|
|
6561
|
+
},
|
|
6562
|
+
"type": {
|
|
6563
|
+
"type": "string",
|
|
6564
|
+
"description": "Filter campaigns by type.\n\nDefaults to `campaign`, which leaves out the emails sent by automations and the double\nopt-in confirmations.",
|
|
6565
|
+
"enum": [
|
|
6566
|
+
"campaign",
|
|
6567
|
+
"automation",
|
|
6568
|
+
"double_opt_in"
|
|
6569
|
+
]
|
|
6570
|
+
},
|
|
6571
|
+
"sort_direction": {
|
|
6572
|
+
"type": "string",
|
|
6573
|
+
"description": "Order campaigns by creation date. Newest first unless set to `asc`.",
|
|
6574
|
+
"enum": [
|
|
6575
|
+
"asc",
|
|
6576
|
+
"desc"
|
|
6577
|
+
]
|
|
6578
|
+
},
|
|
6579
|
+
"page": {
|
|
6580
|
+
"type": "integer",
|
|
6581
|
+
"description": "Page number"
|
|
6582
|
+
},
|
|
6583
|
+
"per_page": {
|
|
6584
|
+
"type": "integer",
|
|
6585
|
+
"description": "Number of items per page"
|
|
6586
|
+
}
|
|
6587
|
+
},
|
|
6588
|
+
"required": [
|
|
6589
|
+
"profileUuid"
|
|
6590
|
+
]
|
|
6591
|
+
},
|
|
6592
|
+
"security": [
|
|
6593
|
+
{
|
|
6594
|
+
"apiToken": []
|
|
6595
|
+
}
|
|
6596
|
+
],
|
|
6597
|
+
"group": "reach"
|
|
6598
|
+
},
|
|
6599
|
+
{
|
|
6600
|
+
"name": "reach_getCampaignPerformanceV1",
|
|
6601
|
+
"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.",
|
|
6602
|
+
"method": "GET",
|
|
6603
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics",
|
|
6604
|
+
"inputSchema": {
|
|
6605
|
+
"type": "object",
|
|
6606
|
+
"properties": {
|
|
6607
|
+
"profileUuid": {
|
|
6608
|
+
"type": "string",
|
|
6609
|
+
"description": "Profile uuid parameter"
|
|
6610
|
+
},
|
|
6611
|
+
"campaignUuid": {
|
|
6612
|
+
"type": "string",
|
|
6613
|
+
"description": "Campaign uuid parameter"
|
|
6614
|
+
}
|
|
6615
|
+
},
|
|
6616
|
+
"required": [
|
|
6617
|
+
"profileUuid",
|
|
6618
|
+
"campaignUuid"
|
|
6619
|
+
]
|
|
6620
|
+
},
|
|
6621
|
+
"security": [
|
|
6622
|
+
{
|
|
6623
|
+
"apiToken": []
|
|
6624
|
+
}
|
|
6625
|
+
],
|
|
6626
|
+
"group": "reach"
|
|
6627
|
+
},
|
|
6510
6628
|
{
|
|
6511
6629
|
"name": "reach_deleteAContactV1",
|
|
6512
6630
|
"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.",
|
|
@@ -7880,6 +7998,96 @@ export default [
|
|
|
7880
7998
|
],
|
|
7881
7999
|
"group": "reach"
|
|
7882
8000
|
},
|
|
8001
|
+
{
|
|
8002
|
+
"name": "reach_getFormDetailsV1",
|
|
8003
|
+
"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.",
|
|
8004
|
+
"method": "GET",
|
|
8005
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}",
|
|
8006
|
+
"inputSchema": {
|
|
8007
|
+
"type": "object",
|
|
8008
|
+
"properties": {
|
|
8009
|
+
"profileUuid": {
|
|
8010
|
+
"type": "string",
|
|
8011
|
+
"description": "Profile uuid parameter"
|
|
8012
|
+
},
|
|
8013
|
+
"formUuid": {
|
|
8014
|
+
"type": "string",
|
|
8015
|
+
"description": "Form uuid parameter"
|
|
8016
|
+
}
|
|
8017
|
+
},
|
|
8018
|
+
"required": [
|
|
8019
|
+
"profileUuid",
|
|
8020
|
+
"formUuid"
|
|
8021
|
+
]
|
|
8022
|
+
},
|
|
8023
|
+
"security": [
|
|
8024
|
+
{
|
|
8025
|
+
"apiToken": []
|
|
8026
|
+
}
|
|
8027
|
+
],
|
|
8028
|
+
"group": "reach"
|
|
8029
|
+
},
|
|
8030
|
+
{
|
|
8031
|
+
"name": "reach_deleteFormV1",
|
|
8032
|
+
"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.",
|
|
8033
|
+
"method": "DELETE",
|
|
8034
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}",
|
|
8035
|
+
"inputSchema": {
|
|
8036
|
+
"type": "object",
|
|
8037
|
+
"properties": {
|
|
8038
|
+
"profileUuid": {
|
|
8039
|
+
"type": "string",
|
|
8040
|
+
"description": "Profile uuid parameter"
|
|
8041
|
+
},
|
|
8042
|
+
"formUuid": {
|
|
8043
|
+
"type": "string",
|
|
8044
|
+
"description": "Form uuid parameter"
|
|
8045
|
+
}
|
|
8046
|
+
},
|
|
8047
|
+
"required": [
|
|
8048
|
+
"profileUuid",
|
|
8049
|
+
"formUuid"
|
|
8050
|
+
]
|
|
8051
|
+
},
|
|
8052
|
+
"security": [
|
|
8053
|
+
{
|
|
8054
|
+
"apiToken": []
|
|
8055
|
+
}
|
|
8056
|
+
],
|
|
8057
|
+
"group": "reach"
|
|
8058
|
+
},
|
|
8059
|
+
{
|
|
8060
|
+
"name": "reach_listFormsV1",
|
|
8061
|
+
"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.",
|
|
8062
|
+
"method": "GET",
|
|
8063
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/forms",
|
|
8064
|
+
"inputSchema": {
|
|
8065
|
+
"type": "object",
|
|
8066
|
+
"properties": {
|
|
8067
|
+
"profileUuid": {
|
|
8068
|
+
"type": "string",
|
|
8069
|
+
"description": "Profile uuid parameter"
|
|
8070
|
+
},
|
|
8071
|
+
"page": {
|
|
8072
|
+
"type": "integer",
|
|
8073
|
+
"description": "Page number"
|
|
8074
|
+
},
|
|
8075
|
+
"per_page": {
|
|
8076
|
+
"type": "integer",
|
|
8077
|
+
"description": "Number of items per page"
|
|
8078
|
+
}
|
|
8079
|
+
},
|
|
8080
|
+
"required": [
|
|
8081
|
+
"profileUuid"
|
|
8082
|
+
]
|
|
8083
|
+
},
|
|
8084
|
+
"security": [
|
|
8085
|
+
{
|
|
8086
|
+
"apiToken": []
|
|
8087
|
+
}
|
|
8088
|
+
],
|
|
8089
|
+
"group": "reach"
|
|
8090
|
+
},
|
|
7883
8091
|
{
|
|
7884
8092
|
"name": "reach_getProfileDomainDNSStatusV1",
|
|
7885
8093
|
"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.",
|
|
@@ -7904,6 +8112,30 @@ export default [
|
|
|
7904
8112
|
],
|
|
7905
8113
|
"group": "reach"
|
|
7906
8114
|
},
|
|
8115
|
+
{
|
|
8116
|
+
"name": "reach_getRemainingPlanLimitsV1",
|
|
8117
|
+
"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.",
|
|
8118
|
+
"method": "GET",
|
|
8119
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/limits",
|
|
8120
|
+
"inputSchema": {
|
|
8121
|
+
"type": "object",
|
|
8122
|
+
"properties": {
|
|
8123
|
+
"profileUuid": {
|
|
8124
|
+
"type": "string",
|
|
8125
|
+
"description": "Profile uuid parameter"
|
|
8126
|
+
}
|
|
8127
|
+
},
|
|
8128
|
+
"required": [
|
|
8129
|
+
"profileUuid"
|
|
8130
|
+
]
|
|
8131
|
+
},
|
|
8132
|
+
"security": [
|
|
8133
|
+
{
|
|
8134
|
+
"apiToken": []
|
|
8135
|
+
}
|
|
8136
|
+
],
|
|
8137
|
+
"group": "reach"
|
|
8138
|
+
},
|
|
7907
8139
|
{
|
|
7908
8140
|
"name": "reach_listProfilesV1",
|
|
7909
8141
|
"description": "This endpoint returns all profiles available to the client, including their basic information.",
|
package/src/core/tools/all.ts
CHANGED
|
@@ -6521,6 +6521,124 @@ const tools: OpenApiTool[] = [
|
|
|
6521
6521
|
],
|
|
6522
6522
|
"group": "reach"
|
|
6523
6523
|
},
|
|
6524
|
+
{
|
|
6525
|
+
"name": "reach_getCampaignDetailsV1",
|
|
6526
|
+
"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.",
|
|
6527
|
+
"method": "GET",
|
|
6528
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}",
|
|
6529
|
+
"inputSchema": {
|
|
6530
|
+
"type": "object",
|
|
6531
|
+
"properties": {
|
|
6532
|
+
"profileUuid": {
|
|
6533
|
+
"type": "string",
|
|
6534
|
+
"description": "Profile uuid parameter"
|
|
6535
|
+
},
|
|
6536
|
+
"campaignUuid": {
|
|
6537
|
+
"type": "string",
|
|
6538
|
+
"description": "Campaign uuid parameter"
|
|
6539
|
+
}
|
|
6540
|
+
},
|
|
6541
|
+
"required": [
|
|
6542
|
+
"profileUuid",
|
|
6543
|
+
"campaignUuid"
|
|
6544
|
+
]
|
|
6545
|
+
},
|
|
6546
|
+
"security": [
|
|
6547
|
+
{
|
|
6548
|
+
"apiToken": []
|
|
6549
|
+
}
|
|
6550
|
+
],
|
|
6551
|
+
"group": "reach"
|
|
6552
|
+
},
|
|
6553
|
+
{
|
|
6554
|
+
"name": "reach_listCampaignsV1",
|
|
6555
|
+
"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.",
|
|
6556
|
+
"method": "GET",
|
|
6557
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns",
|
|
6558
|
+
"inputSchema": {
|
|
6559
|
+
"type": "object",
|
|
6560
|
+
"properties": {
|
|
6561
|
+
"profileUuid": {
|
|
6562
|
+
"type": "string",
|
|
6563
|
+
"description": "Profile uuid parameter"
|
|
6564
|
+
},
|
|
6565
|
+
"status": {
|
|
6566
|
+
"type": "string",
|
|
6567
|
+
"description": "Filter campaigns by status.\n\nA fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can\nbe neither paused nor archived.",
|
|
6568
|
+
"enum": [
|
|
6569
|
+
"draft",
|
|
6570
|
+
"scheduled",
|
|
6571
|
+
"sending",
|
|
6572
|
+
"publish",
|
|
6573
|
+
"failed"
|
|
6574
|
+
]
|
|
6575
|
+
},
|
|
6576
|
+
"type": {
|
|
6577
|
+
"type": "string",
|
|
6578
|
+
"description": "Filter campaigns by type.\n\nDefaults to `campaign`, which leaves out the emails sent by automations and the double\nopt-in confirmations.",
|
|
6579
|
+
"enum": [
|
|
6580
|
+
"campaign",
|
|
6581
|
+
"automation",
|
|
6582
|
+
"double_opt_in"
|
|
6583
|
+
]
|
|
6584
|
+
},
|
|
6585
|
+
"sort_direction": {
|
|
6586
|
+
"type": "string",
|
|
6587
|
+
"description": "Order campaigns by creation date. Newest first unless set to `asc`.",
|
|
6588
|
+
"enum": [
|
|
6589
|
+
"asc",
|
|
6590
|
+
"desc"
|
|
6591
|
+
]
|
|
6592
|
+
},
|
|
6593
|
+
"page": {
|
|
6594
|
+
"type": "integer",
|
|
6595
|
+
"description": "Page number"
|
|
6596
|
+
},
|
|
6597
|
+
"per_page": {
|
|
6598
|
+
"type": "integer",
|
|
6599
|
+
"description": "Number of items per page"
|
|
6600
|
+
}
|
|
6601
|
+
},
|
|
6602
|
+
"required": [
|
|
6603
|
+
"profileUuid"
|
|
6604
|
+
]
|
|
6605
|
+
},
|
|
6606
|
+
"security": [
|
|
6607
|
+
{
|
|
6608
|
+
"apiToken": []
|
|
6609
|
+
}
|
|
6610
|
+
],
|
|
6611
|
+
"group": "reach"
|
|
6612
|
+
},
|
|
6613
|
+
{
|
|
6614
|
+
"name": "reach_getCampaignPerformanceV1",
|
|
6615
|
+
"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.",
|
|
6616
|
+
"method": "GET",
|
|
6617
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics",
|
|
6618
|
+
"inputSchema": {
|
|
6619
|
+
"type": "object",
|
|
6620
|
+
"properties": {
|
|
6621
|
+
"profileUuid": {
|
|
6622
|
+
"type": "string",
|
|
6623
|
+
"description": "Profile uuid parameter"
|
|
6624
|
+
},
|
|
6625
|
+
"campaignUuid": {
|
|
6626
|
+
"type": "string",
|
|
6627
|
+
"description": "Campaign uuid parameter"
|
|
6628
|
+
}
|
|
6629
|
+
},
|
|
6630
|
+
"required": [
|
|
6631
|
+
"profileUuid",
|
|
6632
|
+
"campaignUuid"
|
|
6633
|
+
]
|
|
6634
|
+
},
|
|
6635
|
+
"security": [
|
|
6636
|
+
{
|
|
6637
|
+
"apiToken": []
|
|
6638
|
+
}
|
|
6639
|
+
],
|
|
6640
|
+
"group": "reach"
|
|
6641
|
+
},
|
|
6524
6642
|
{
|
|
6525
6643
|
"name": "reach_deleteAContactV1",
|
|
6526
6644
|
"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.",
|
|
@@ -7894,6 +8012,96 @@ const tools: OpenApiTool[] = [
|
|
|
7894
8012
|
],
|
|
7895
8013
|
"group": "reach"
|
|
7896
8014
|
},
|
|
8015
|
+
{
|
|
8016
|
+
"name": "reach_getFormDetailsV1",
|
|
8017
|
+
"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.",
|
|
8018
|
+
"method": "GET",
|
|
8019
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}",
|
|
8020
|
+
"inputSchema": {
|
|
8021
|
+
"type": "object",
|
|
8022
|
+
"properties": {
|
|
8023
|
+
"profileUuid": {
|
|
8024
|
+
"type": "string",
|
|
8025
|
+
"description": "Profile uuid parameter"
|
|
8026
|
+
},
|
|
8027
|
+
"formUuid": {
|
|
8028
|
+
"type": "string",
|
|
8029
|
+
"description": "Form uuid parameter"
|
|
8030
|
+
}
|
|
8031
|
+
},
|
|
8032
|
+
"required": [
|
|
8033
|
+
"profileUuid",
|
|
8034
|
+
"formUuid"
|
|
8035
|
+
]
|
|
8036
|
+
},
|
|
8037
|
+
"security": [
|
|
8038
|
+
{
|
|
8039
|
+
"apiToken": []
|
|
8040
|
+
}
|
|
8041
|
+
],
|
|
8042
|
+
"group": "reach"
|
|
8043
|
+
},
|
|
8044
|
+
{
|
|
8045
|
+
"name": "reach_deleteFormV1",
|
|
8046
|
+
"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.",
|
|
8047
|
+
"method": "DELETE",
|
|
8048
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}",
|
|
8049
|
+
"inputSchema": {
|
|
8050
|
+
"type": "object",
|
|
8051
|
+
"properties": {
|
|
8052
|
+
"profileUuid": {
|
|
8053
|
+
"type": "string",
|
|
8054
|
+
"description": "Profile uuid parameter"
|
|
8055
|
+
},
|
|
8056
|
+
"formUuid": {
|
|
8057
|
+
"type": "string",
|
|
8058
|
+
"description": "Form uuid parameter"
|
|
8059
|
+
}
|
|
8060
|
+
},
|
|
8061
|
+
"required": [
|
|
8062
|
+
"profileUuid",
|
|
8063
|
+
"formUuid"
|
|
8064
|
+
]
|
|
8065
|
+
},
|
|
8066
|
+
"security": [
|
|
8067
|
+
{
|
|
8068
|
+
"apiToken": []
|
|
8069
|
+
}
|
|
8070
|
+
],
|
|
8071
|
+
"group": "reach"
|
|
8072
|
+
},
|
|
8073
|
+
{
|
|
8074
|
+
"name": "reach_listFormsV1",
|
|
8075
|
+
"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.",
|
|
8076
|
+
"method": "GET",
|
|
8077
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/forms",
|
|
8078
|
+
"inputSchema": {
|
|
8079
|
+
"type": "object",
|
|
8080
|
+
"properties": {
|
|
8081
|
+
"profileUuid": {
|
|
8082
|
+
"type": "string",
|
|
8083
|
+
"description": "Profile uuid parameter"
|
|
8084
|
+
},
|
|
8085
|
+
"page": {
|
|
8086
|
+
"type": "integer",
|
|
8087
|
+
"description": "Page number"
|
|
8088
|
+
},
|
|
8089
|
+
"per_page": {
|
|
8090
|
+
"type": "integer",
|
|
8091
|
+
"description": "Number of items per page"
|
|
8092
|
+
}
|
|
8093
|
+
},
|
|
8094
|
+
"required": [
|
|
8095
|
+
"profileUuid"
|
|
8096
|
+
]
|
|
8097
|
+
},
|
|
8098
|
+
"security": [
|
|
8099
|
+
{
|
|
8100
|
+
"apiToken": []
|
|
8101
|
+
}
|
|
8102
|
+
],
|
|
8103
|
+
"group": "reach"
|
|
8104
|
+
},
|
|
7897
8105
|
{
|
|
7898
8106
|
"name": "reach_getProfileDomainDNSStatusV1",
|
|
7899
8107
|
"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.",
|
|
@@ -7918,6 +8126,30 @@ const tools: OpenApiTool[] = [
|
|
|
7918
8126
|
],
|
|
7919
8127
|
"group": "reach"
|
|
7920
8128
|
},
|
|
8129
|
+
{
|
|
8130
|
+
"name": "reach_getRemainingPlanLimitsV1",
|
|
8131
|
+
"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.",
|
|
8132
|
+
"method": "GET",
|
|
8133
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/limits",
|
|
8134
|
+
"inputSchema": {
|
|
8135
|
+
"type": "object",
|
|
8136
|
+
"properties": {
|
|
8137
|
+
"profileUuid": {
|
|
8138
|
+
"type": "string",
|
|
8139
|
+
"description": "Profile uuid parameter"
|
|
8140
|
+
}
|
|
8141
|
+
},
|
|
8142
|
+
"required": [
|
|
8143
|
+
"profileUuid"
|
|
8144
|
+
]
|
|
8145
|
+
},
|
|
8146
|
+
"security": [
|
|
8147
|
+
{
|
|
8148
|
+
"apiToken": []
|
|
8149
|
+
}
|
|
8150
|
+
],
|
|
8151
|
+
"group": "reach"
|
|
8152
|
+
},
|
|
7921
8153
|
{
|
|
7922
8154
|
"name": "reach_listProfilesV1",
|
|
7923
8155
|
"description": "This endpoint returns all profiles available to the client, including their basic information.",
|