hostinger-api-mcp 1.35.6 → 1.37.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 +106 -31
- 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/agency-hosting.js +25 -25
- package/src/core/tools/agency-hosting.ts +25 -25
- package/src/core/tools/all.js +287 -30
- package/src/core/tools/all.ts +287 -30
- package/src/core/tools/ecommerce.js +37 -5
- package/src/core/tools/ecommerce.ts +37 -5
- package/src/core/tools/reach.js +225 -0
- package/src/core/tools/reach.ts +225 -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 +218 -30
package/src/core/tools/all.js
CHANGED
|
@@ -326,7 +326,7 @@ export default [
|
|
|
326
326
|
"group": "hosting"
|
|
327
327
|
},
|
|
328
328
|
{
|
|
329
|
-
"name": "agency-
|
|
329
|
+
"name": "agency-hosting_listAvailableDatacentersV1",
|
|
330
330
|
"description": "Lists the datacenters available for provisioning a new website on the given Agency Plan\nhosting order.\n\nEach datacenter includes a `pinger_url` you can ping from the client to measure round-trip\nlatency; comparing the results across datacenters lets you pick the nearest one (lowest\nping) before choosing its `code` as the `datacenter_code` when creating a website setup.",
|
|
331
331
|
"method": "GET",
|
|
332
332
|
"path": "/api/agency-hosting/v1/orders/{order_id}/datacenters",
|
|
@@ -350,7 +350,7 @@ export default [
|
|
|
350
350
|
"group": "agency-hosting"
|
|
351
351
|
},
|
|
352
352
|
{
|
|
353
|
-
"name": "agency-
|
|
353
|
+
"name": "agency-hosting_changeWebsiteDomainV1",
|
|
354
354
|
"description": "Changes the primary domain for an Agency Plan website.\n\nProvide the current domain in the path and the new domain in the request body.\nSet domain to null to revert to the temporary domain.",
|
|
355
355
|
"method": "PUT",
|
|
356
356
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/domains/{from_domain}",
|
|
@@ -384,7 +384,7 @@ export default [
|
|
|
384
384
|
"group": "agency-hosting"
|
|
385
385
|
},
|
|
386
386
|
{
|
|
387
|
-
"name": "agency-
|
|
387
|
+
"name": "agency-hosting_linkDomainToWebsiteV1",
|
|
388
388
|
"description": "Links a domain to the specified Agency Plan website so it can serve traffic for that domain.",
|
|
389
389
|
"method": "POST",
|
|
390
390
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/domains",
|
|
@@ -413,7 +413,7 @@ export default [
|
|
|
413
413
|
"group": "agency-hosting"
|
|
414
414
|
},
|
|
415
415
|
{
|
|
416
|
-
"name": "agency-
|
|
416
|
+
"name": "agency-hosting_listDomainsV1",
|
|
417
417
|
"description": "Returns a paginated list of domains associated with Agency Plan websites accessible to the authenticated client.\n\nUse the website_uuids filter to narrow results to specific websites.",
|
|
418
418
|
"method": "GET",
|
|
419
419
|
"path": "/api/agency-hosting/v1/domains",
|
|
@@ -447,7 +447,7 @@ export default [
|
|
|
447
447
|
"group": "agency-hosting"
|
|
448
448
|
},
|
|
449
449
|
{
|
|
450
|
-
"name": "agency-
|
|
450
|
+
"name": "agency-hosting_unlinkDomainFromWebsiteV1",
|
|
451
451
|
"description": "Unlinks a domain from the specified Agency Plan website.\n\nThe website stops serving traffic on this domain immediately.\n\nWebsite files and database are preserved, and any other linked domains remain accessible.\n\nIf this is the only domain on the website, unlinking leaves the website without an accessible domain.",
|
|
452
452
|
"method": "DELETE",
|
|
453
453
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}",
|
|
@@ -476,7 +476,7 @@ export default [
|
|
|
476
476
|
"group": "agency-hosting"
|
|
477
477
|
},
|
|
478
478
|
{
|
|
479
|
-
"name": "agency-
|
|
479
|
+
"name": "agency-hosting_importWebsiteFromArchiveV1",
|
|
480
480
|
"description": "Imports an Agency Plan website from an already-uploaded archive.\n\nUpload the archive to the website's root directory via file browser first, then provide its\nfilename in this request. Website contents are overwritten by the archive contents. Supported\narchive types: .zip, .tar, .tar.gz, .tgz.",
|
|
481
481
|
"method": "POST",
|
|
482
482
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/files/import-archive",
|
|
@@ -505,7 +505,7 @@ export default [
|
|
|
505
505
|
"group": "agency-hosting"
|
|
506
506
|
},
|
|
507
507
|
{
|
|
508
|
-
"name": "agency-
|
|
508
|
+
"name": "agency-hosting_listOrdersV1",
|
|
509
509
|
"description": "Returns a paginated list of Agency Plan orders accessible to the authenticated client.",
|
|
510
510
|
"method": "GET",
|
|
511
511
|
"path": "/api/agency-hosting/v1/orders",
|
|
@@ -531,7 +531,7 @@ export default [
|
|
|
531
531
|
"group": "agency-hosting"
|
|
532
532
|
},
|
|
533
533
|
{
|
|
534
|
-
"name": "agency-
|
|
534
|
+
"name": "agency-hosting_createANewWebsiteV1",
|
|
535
535
|
"description": "Provisions a new website on one of your Agency Plan hosting orders.\n\nChoose the datacenter, stack (`flavor`), and PHP version for the site. Optionally attach\nyour own `domain` — omit it, set it to `null`, or leave it unavailable and a free\n`*.hostingersite.com` subdomain is generated instead — and/or install WordPress by\nsupplying the `wordpress` details (admin account, site title, and language).\n\nCommon setups:\n- **Plain PHP site**: `flavor` set to `php-fpm`, with `settings.php.version`; omit\n `wordpress` and `type`.\n- **WordPress site**: `flavor` set to the desired WordPress version (e.g. `wp-7.0`), plus\n the `wordpress` block (admin account, title, language).\n- **Static/Node.js frontend app**: `flavor` set to `php-fpm` and `type` set to\n `node-static`.\n\nProvisioning runs in the background, so the response returns immediately with a setup UUID\nthat identifies the job. The new website becomes reachable once provisioning finishes.",
|
|
536
536
|
"method": "POST",
|
|
537
537
|
"path": "/api/agency-hosting/v1/orders/{order_id}/websites/setups",
|
|
@@ -682,7 +682,7 @@ export default [
|
|
|
682
682
|
"group": "agency-hosting"
|
|
683
683
|
},
|
|
684
684
|
{
|
|
685
|
-
"name": "agency-
|
|
685
|
+
"name": "agency-hosting_getWebsiteSetupStatusV1",
|
|
686
686
|
"description": "Returns the current status of an Agency Plan website setup started via the setups\nendpoint.\n\nPoll this endpoint using the `setup_uuid` returned from the provisioning request until\n`status` becomes `completed`, at which point `website_uid` identifies the new website.",
|
|
687
687
|
"method": "GET",
|
|
688
688
|
"path": "/api/agency-hosting/v1/orders/{order_id}/websites/setups/{setup_uuid}",
|
|
@@ -711,7 +711,7 @@ export default [
|
|
|
711
711
|
"group": "agency-hosting"
|
|
712
712
|
},
|
|
713
713
|
{
|
|
714
|
-
"name": "agency-
|
|
714
|
+
"name": "agency-hosting_buildWebsiteNodeJSAssetsV1",
|
|
715
715
|
"description": "Builds and deploys a Node.js application for an Agency Plan website from an already-uploaded archive.\n\nUpload the archive to file browser first, then provide its relative path from document root in this request.\nWebsite contents are overwritten by the build result, which is deployed to public_html.",
|
|
716
716
|
"method": "POST",
|
|
717
717
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/build-assets",
|
|
@@ -740,7 +740,7 @@ export default [
|
|
|
740
740
|
"group": "agency-hosting"
|
|
741
741
|
},
|
|
742
742
|
{
|
|
743
|
-
"name": "agency-
|
|
743
|
+
"name": "agency-hosting_clearWebsiteCacheV1",
|
|
744
744
|
"description": "Clears cache for all domains associated with an Agency Plan website, including its preview domain.\n\nThis operation clears all cache types for the website.",
|
|
745
745
|
"method": "DELETE",
|
|
746
746
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/cache",
|
|
@@ -764,7 +764,7 @@ export default [
|
|
|
764
764
|
"group": "agency-hosting"
|
|
765
765
|
},
|
|
766
766
|
{
|
|
767
|
-
"name": "agency-
|
|
767
|
+
"name": "agency-hosting_listWebsiteCronJobsV1",
|
|
768
768
|
"description": "Returns a paginated list of cron jobs configured for an Agency Plan website.\n\nEach entry includes the schedule expression and the command executed on that schedule.",
|
|
769
769
|
"method": "GET",
|
|
770
770
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/cron-jobs",
|
|
@@ -796,7 +796,7 @@ export default [
|
|
|
796
796
|
"group": "agency-hosting"
|
|
797
797
|
},
|
|
798
798
|
{
|
|
799
|
-
"name": "agency-
|
|
799
|
+
"name": "agency-hosting_createWebsiteCronJobV1",
|
|
800
800
|
"description": "Creates a cron job for an Agency Plan website from a schedule expression and a command.\n\nReturns the created cron job, including its uuid, which is required to delete the cron job.",
|
|
801
801
|
"method": "POST",
|
|
802
802
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/cron-jobs",
|
|
@@ -830,7 +830,7 @@ export default [
|
|
|
830
830
|
"group": "agency-hosting"
|
|
831
831
|
},
|
|
832
832
|
{
|
|
833
|
-
"name": "agency-
|
|
833
|
+
"name": "agency-hosting_deleteWebsiteCronJobV1",
|
|
834
834
|
"description": "Permanently deletes the cron job identified by its uuid from an Agency Plan website.\n\nThe operation is idempotent: deleting a cron job that does not exist succeeds without error.",
|
|
835
835
|
"method": "DELETE",
|
|
836
836
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/cron-jobs/{uuid}",
|
|
@@ -859,7 +859,7 @@ export default [
|
|
|
859
859
|
"group": "agency-hosting"
|
|
860
860
|
},
|
|
861
861
|
{
|
|
862
|
-
"name": "agency-
|
|
862
|
+
"name": "agency-hosting_listWebsiteDatabasesV1",
|
|
863
863
|
"description": "Returns a paginated list of MySQL databases created for an Agency Plan website.\n\nEach entry includes the database's non-system users.",
|
|
864
864
|
"method": "GET",
|
|
865
865
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/databases",
|
|
@@ -891,7 +891,7 @@ export default [
|
|
|
891
891
|
"group": "agency-hosting"
|
|
892
892
|
},
|
|
893
893
|
{
|
|
894
|
-
"name": "agency-
|
|
894
|
+
"name": "agency-hosting_createWebsiteDatabaseV1",
|
|
895
895
|
"description": "Creates a MySQL database with a dedicated user for an Agency Plan website.\n\nThe database name, username, and password must all be provided by the caller.",
|
|
896
896
|
"method": "POST",
|
|
897
897
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/databases",
|
|
@@ -930,7 +930,7 @@ export default [
|
|
|
930
930
|
"group": "agency-hosting"
|
|
931
931
|
},
|
|
932
932
|
{
|
|
933
|
-
"name": "agency-
|
|
933
|
+
"name": "agency-hosting_deleteWebsiteDatabaseV1",
|
|
934
934
|
"description": "Permanently deletes a MySQL database and all its data from an Agency Plan website, including its users.\n\nThe operation is idempotent: deleting a database that does not exist succeeds without error.",
|
|
935
935
|
"method": "DELETE",
|
|
936
936
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}",
|
|
@@ -959,7 +959,7 @@ export default [
|
|
|
959
959
|
"group": "agency-hosting"
|
|
960
960
|
},
|
|
961
961
|
{
|
|
962
|
-
"name": "agency-
|
|
962
|
+
"name": "agency-hosting_createWebsiteDatabaseUserV1",
|
|
963
963
|
"description": "Creates a user for an existing database on an Agency Plan website.\n\nEach database supports a single non-system user; creating a user for a database that already has one fails.",
|
|
964
964
|
"method": "POST",
|
|
965
965
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users",
|
|
@@ -1002,7 +1002,7 @@ export default [
|
|
|
1002
1002
|
"group": "agency-hosting"
|
|
1003
1003
|
},
|
|
1004
1004
|
{
|
|
1005
|
-
"name": "agency-
|
|
1005
|
+
"name": "agency-hosting_deleteWebsiteDatabaseUserV1",
|
|
1006
1006
|
"description": "Permanently deletes a database user from an Agency Plan website database, revoking all access it had.\n\nThe operation is idempotent: deleting a user that does not exist succeeds without error.",
|
|
1007
1007
|
"method": "DELETE",
|
|
1008
1008
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users/{database_user_name}",
|
|
@@ -1036,7 +1036,7 @@ export default [
|
|
|
1036
1036
|
"group": "agency-hosting"
|
|
1037
1037
|
},
|
|
1038
1038
|
{
|
|
1039
|
-
"name": "agency-
|
|
1039
|
+
"name": "agency-hosting_getWebsiteDetailsV1",
|
|
1040
1040
|
"description": "Retrieves detailed information about a specific Agency Plan website, including configuration,\nstatus, metadata, hosting plan details, and resource quotas.",
|
|
1041
1041
|
"method": "GET",
|
|
1042
1042
|
"path": "/api/agency-hosting/v1/websites/{website_uid}",
|
|
@@ -1060,7 +1060,7 @@ export default [
|
|
|
1060
1060
|
"group": "agency-hosting"
|
|
1061
1061
|
},
|
|
1062
1062
|
{
|
|
1063
|
-
"name": "agency-
|
|
1063
|
+
"name": "agency-hosting_deleteWebsiteV1",
|
|
1064
1064
|
"description": "Permanently deletes an Agency Plan website. Deletion is processed asynchronously: the\nwebsite is immediately transitioned to a deleting state and the underlying server\nresources are removed in the background.",
|
|
1065
1065
|
"method": "DELETE",
|
|
1066
1066
|
"path": "/api/agency-hosting/v1/websites/{website_uid}",
|
|
@@ -1084,7 +1084,7 @@ export default [
|
|
|
1084
1084
|
"group": "agency-hosting"
|
|
1085
1085
|
},
|
|
1086
1086
|
{
|
|
1087
|
-
"name": "agency-
|
|
1087
|
+
"name": "agency-hosting_listWebsiteProcessesV1",
|
|
1088
1088
|
"description": "Lists active and recently completed asynchronous processes for an Agency Plan website.\n\nEach process has a unique ID (for tracking), a type, and a status (running, completed, failed).\nPoll this endpoint after initiating async operations (SSL setup, backups, cloning) to track progress.",
|
|
1089
1089
|
"method": "GET",
|
|
1090
1090
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/processes",
|
|
@@ -1108,7 +1108,7 @@ export default [
|
|
|
1108
1108
|
"group": "agency-hosting"
|
|
1109
1109
|
},
|
|
1110
1110
|
{
|
|
1111
|
-
"name": "agency-
|
|
1111
|
+
"name": "agency-hosting_changeWordPressVersionV1",
|
|
1112
1112
|
"description": "Changes the installed WordPress core version on an Agency Plan website to one of the versions available for installation.",
|
|
1113
1113
|
"method": "PATCH",
|
|
1114
1114
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/version",
|
|
@@ -1137,7 +1137,7 @@ export default [
|
|
|
1137
1137
|
"group": "agency-hosting"
|
|
1138
1138
|
},
|
|
1139
1139
|
{
|
|
1140
|
-
"name": "agency-
|
|
1140
|
+
"name": "agency-hosting_getWordPressSettingsV1",
|
|
1141
1141
|
"description": "Returns the current WordPress settings for an Agency Plan website: installed core version,\nLiteSpeed Cache plugin status, object cache status, and maintenance mode status.",
|
|
1142
1142
|
"method": "GET",
|
|
1143
1143
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings",
|
|
@@ -1161,7 +1161,7 @@ export default [
|
|
|
1161
1161
|
"group": "agency-hosting"
|
|
1162
1162
|
},
|
|
1163
1163
|
{
|
|
1164
|
-
"name": "agency-
|
|
1164
|
+
"name": "agency-hosting_listAvailableWordPressVersionsV1",
|
|
1165
1165
|
"description": "Lists the WordPress core versions available for installation on an Agency Plan website.",
|
|
1166
1166
|
"method": "GET",
|
|
1167
1167
|
"path": "/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/versions",
|
|
@@ -2996,6 +2996,35 @@ export default [
|
|
|
2996
2996
|
],
|
|
2997
2997
|
"group": "ecommerce"
|
|
2998
2998
|
},
|
|
2999
|
+
{
|
|
3000
|
+
"name": "ecommerce_createAProductImageUploadURLV1",
|
|
3001
|
+
"description": "Returns a signed URL to upload a product image to (multipart/form-data POST). Then call the\nattach-image endpoint with the returned object_name to scan and attach it to the product.",
|
|
3002
|
+
"method": "POST",
|
|
3003
|
+
"path": "/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images/upload-url",
|
|
3004
|
+
"inputSchema": {
|
|
3005
|
+
"type": "object",
|
|
3006
|
+
"properties": {
|
|
3007
|
+
"store_id": {
|
|
3008
|
+
"type": "string",
|
|
3009
|
+
"description": "The ID of the store the product belongs to."
|
|
3010
|
+
},
|
|
3011
|
+
"product_id": {
|
|
3012
|
+
"type": "string",
|
|
3013
|
+
"description": "The ID of the product the image will be attached to."
|
|
3014
|
+
}
|
|
3015
|
+
},
|
|
3016
|
+
"required": [
|
|
3017
|
+
"store_id",
|
|
3018
|
+
"product_id"
|
|
3019
|
+
]
|
|
3020
|
+
},
|
|
3021
|
+
"security": [
|
|
3022
|
+
{
|
|
3023
|
+
"apiToken": []
|
|
3024
|
+
}
|
|
3025
|
+
],
|
|
3026
|
+
"group": "ecommerce"
|
|
3027
|
+
},
|
|
2999
3028
|
{
|
|
3000
3029
|
"name": "ecommerce_createDigitalProductV1",
|
|
3001
3030
|
"description": "Create a published digital product with a single variant and an optional external download link.",
|
|
@@ -3086,7 +3115,7 @@ export default [
|
|
|
3086
3115
|
},
|
|
3087
3116
|
{
|
|
3088
3117
|
"name": "ecommerce_uploadAndAttachAProductImageV1",
|
|
3089
|
-
"description": "
|
|
3118
|
+
"description": "Fetch a raster image (JPEG, PNG, GIF or WebP, max 15MB) from a URL and attach it to a product in a\nsingle call. The image is virus-scanned and validated by content, then stored on the CDN. Set\nis_thumbnail to make it the product's primary image.",
|
|
3090
3119
|
"method": "POST",
|
|
3091
3120
|
"path": "/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images",
|
|
3092
3121
|
"inputSchema": {
|
|
@@ -3100,9 +3129,13 @@ export default [
|
|
|
3100
3129
|
"type": "string",
|
|
3101
3130
|
"description": "The ID of the product to attach the image to."
|
|
3102
3131
|
},
|
|
3103
|
-
"
|
|
3132
|
+
"image_url": {
|
|
3133
|
+
"type": "string",
|
|
3134
|
+
"description": "Publicly reachable URL of the raster image (JPEG, PNG, GIF or WebP), maximum 15MB. The image is\nfetched, virus-scanned and validated by content, then stored on the CDN. SVG is not accepted.\nProvide either this or object_name."
|
|
3135
|
+
},
|
|
3136
|
+
"object_name": {
|
|
3104
3137
|
"type": "string",
|
|
3105
|
-
"description": "
|
|
3138
|
+
"description": "Key returned by the upload-url endpoint. Provide this instead of image_url to attach an uploaded image."
|
|
3106
3139
|
},
|
|
3107
3140
|
"is_thumbnail": {
|
|
3108
3141
|
"type": "boolean",
|
|
@@ -3111,8 +3144,7 @@ export default [
|
|
|
3111
3144
|
},
|
|
3112
3145
|
"required": [
|
|
3113
3146
|
"store_id",
|
|
3114
|
-
"product_id"
|
|
3115
|
-
"image"
|
|
3147
|
+
"product_id"
|
|
3116
3148
|
]
|
|
3117
3149
|
},
|
|
3118
3150
|
"security": [
|
|
@@ -6368,6 +6400,231 @@ export default [
|
|
|
6368
6400
|
],
|
|
6369
6401
|
"group": "mail"
|
|
6370
6402
|
},
|
|
6403
|
+
{
|
|
6404
|
+
"name": "reach_getAutomationDetailsV1",
|
|
6405
|
+
"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.",
|
|
6406
|
+
"method": "GET",
|
|
6407
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}",
|
|
6408
|
+
"inputSchema": {
|
|
6409
|
+
"type": "object",
|
|
6410
|
+
"properties": {
|
|
6411
|
+
"profileUuid": {
|
|
6412
|
+
"type": "string",
|
|
6413
|
+
"description": "Profile uuid parameter"
|
|
6414
|
+
},
|
|
6415
|
+
"automationUuid": {
|
|
6416
|
+
"type": "string",
|
|
6417
|
+
"description": "Automation uuid parameter"
|
|
6418
|
+
}
|
|
6419
|
+
},
|
|
6420
|
+
"required": [
|
|
6421
|
+
"profileUuid",
|
|
6422
|
+
"automationUuid"
|
|
6423
|
+
]
|
|
6424
|
+
},
|
|
6425
|
+
"security": [
|
|
6426
|
+
{
|
|
6427
|
+
"apiToken": []
|
|
6428
|
+
}
|
|
6429
|
+
],
|
|
6430
|
+
"group": "reach"
|
|
6431
|
+
},
|
|
6432
|
+
{
|
|
6433
|
+
"name": "reach_listAutomationsV1",
|
|
6434
|
+
"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.",
|
|
6435
|
+
"method": "GET",
|
|
6436
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/automations",
|
|
6437
|
+
"inputSchema": {
|
|
6438
|
+
"type": "object",
|
|
6439
|
+
"properties": {
|
|
6440
|
+
"profileUuid": {
|
|
6441
|
+
"type": "string",
|
|
6442
|
+
"description": "Profile uuid parameter"
|
|
6443
|
+
},
|
|
6444
|
+
"status": {
|
|
6445
|
+
"type": "string",
|
|
6446
|
+
"description": "Filter automations by status.\n\nThere is no `completed` status. An automation that has finished for every contact still\nreports `active`.",
|
|
6447
|
+
"enum": [
|
|
6448
|
+
"active",
|
|
6449
|
+
"paused",
|
|
6450
|
+
"draft"
|
|
6451
|
+
]
|
|
6452
|
+
},
|
|
6453
|
+
"sort_direction": {
|
|
6454
|
+
"type": "string",
|
|
6455
|
+
"description": "Order automations by creation date. Newest first unless set to `asc`.",
|
|
6456
|
+
"enum": [
|
|
6457
|
+
"asc",
|
|
6458
|
+
"desc"
|
|
6459
|
+
]
|
|
6460
|
+
},
|
|
6461
|
+
"page": {
|
|
6462
|
+
"type": "integer",
|
|
6463
|
+
"description": "Page number"
|
|
6464
|
+
},
|
|
6465
|
+
"per_page": {
|
|
6466
|
+
"type": "integer",
|
|
6467
|
+
"description": "Number of items per page"
|
|
6468
|
+
}
|
|
6469
|
+
},
|
|
6470
|
+
"required": [
|
|
6471
|
+
"profileUuid"
|
|
6472
|
+
]
|
|
6473
|
+
},
|
|
6474
|
+
"security": [
|
|
6475
|
+
{
|
|
6476
|
+
"apiToken": []
|
|
6477
|
+
}
|
|
6478
|
+
],
|
|
6479
|
+
"group": "reach"
|
|
6480
|
+
},
|
|
6481
|
+
{
|
|
6482
|
+
"name": "reach_listAutomationStepsV1",
|
|
6483
|
+
"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.",
|
|
6484
|
+
"method": "GET",
|
|
6485
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps",
|
|
6486
|
+
"inputSchema": {
|
|
6487
|
+
"type": "object",
|
|
6488
|
+
"properties": {
|
|
6489
|
+
"profileUuid": {
|
|
6490
|
+
"type": "string",
|
|
6491
|
+
"description": "Profile uuid parameter"
|
|
6492
|
+
},
|
|
6493
|
+
"automationUuid": {
|
|
6494
|
+
"type": "string",
|
|
6495
|
+
"description": "Automation uuid parameter"
|
|
6496
|
+
}
|
|
6497
|
+
},
|
|
6498
|
+
"required": [
|
|
6499
|
+
"profileUuid",
|
|
6500
|
+
"automationUuid"
|
|
6501
|
+
]
|
|
6502
|
+
},
|
|
6503
|
+
"security": [
|
|
6504
|
+
{
|
|
6505
|
+
"apiToken": []
|
|
6506
|
+
}
|
|
6507
|
+
],
|
|
6508
|
+
"group": "reach"
|
|
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
|
+
},
|
|
6371
6628
|
{
|
|
6372
6629
|
"name": "reach_deleteAContactV1",
|
|
6373
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.",
|