hostinger-api-mcp 1.32.0 → 1.33.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 +78 -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 +324 -4
- package/src/core/tools/all.ts +324 -4
- package/src/core/tools/reach.js +324 -4
- package/src/core/tools/reach.ts +324 -4
- 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 +164 -0
package/README.md
CHANGED
|
@@ -49,7 +49,7 @@ pnpm update -g hostinger-api-mcp
|
|
|
49
49
|
|
|
50
50
|
This package installs the following MCP server commands:
|
|
51
51
|
|
|
52
|
-
- `hostinger-api-mcp` — unified server with every tool (
|
|
52
|
+
- `hostinger-api-mcp` — unified server with every tool (314 total)
|
|
53
53
|
- `hostinger-agency-hosting-mcp` — 27 tools for agency-hosting
|
|
54
54
|
- `hostinger-billing-mcp` — 9 tools for billing
|
|
55
55
|
- `hostinger-dns-mcp` — 8 tools for dns
|
|
@@ -58,7 +58,7 @@ This package installs the following MCP server commands:
|
|
|
58
58
|
- `hostinger-horizons-mcp` — 2 tools for horizons
|
|
59
59
|
- `hostinger-hosting-mcp` — 48 tools for hosting
|
|
60
60
|
- `hostinger-mail-mcp` — 38 tools for mail
|
|
61
|
-
- `hostinger-reach-mcp` —
|
|
61
|
+
- `hostinger-reach-mcp` — 35 tools for reach
|
|
62
62
|
- `hostinger-vps-mcp` — 62 tools for vps
|
|
63
63
|
- `hostinger-wordpress-mcp` — 35 tools for wordpress
|
|
64
64
|
|
|
@@ -2290,6 +2290,10 @@ Get a list of all contact segments.
|
|
|
2290
2290
|
|
|
2291
2291
|
This endpoint returns a list of contact segments that can be used to organize contacts.
|
|
2292
2292
|
|
|
2293
|
+
**Deprecated.** This endpoint cannot target a profile, so it always falls back to
|
|
2294
|
+
the client's default profile and cannot list the segments of any other profile. Use
|
|
2295
|
+
`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.
|
|
2296
|
+
|
|
2293
2297
|
- **Method**: `GET`
|
|
2294
2298
|
- **Path**: `/api/reach/v1/segmentation/segments`
|
|
2295
2299
|
|
|
@@ -2300,9 +2304,22 @@ Create a new contact segment.
|
|
|
2300
2304
|
This endpoint allows creating a new contact segment that can be used to organize contacts.
|
|
2301
2305
|
The segment can be configured with specific criteria like email, name, subscription status, etc.
|
|
2302
2306
|
|
|
2307
|
+
**Deprecated.** This endpoint cannot target a profile, so it always falls back to
|
|
2308
|
+
the client's default profile and cannot create segments in any other profile. Use
|
|
2309
|
+
`POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.
|
|
2310
|
+
|
|
2303
2311
|
- **Method**: `POST`
|
|
2304
2312
|
- **Path**: `/api/reach/v1/segmentation/segments`
|
|
2305
2313
|
|
|
2314
|
+
#### reach_countProfileSegmentContactsV1
|
|
2315
|
+
|
|
2316
|
+
Count the contacts currently matching a segment without listing them.
|
|
2317
|
+
|
|
2318
|
+
Cheaper than paging through the segment contacts endpoint when only the size is needed.
|
|
2319
|
+
|
|
2320
|
+
- **Method**: `GET`
|
|
2321
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count`
|
|
2322
|
+
|
|
2306
2323
|
#### reach_listProfileSegmentContactsV1
|
|
2307
2324
|
|
|
2308
2325
|
Retrieve contacts associated with a specific segment for a given profile.
|
|
@@ -2313,6 +2330,57 @@ identified by its UUID, scoped to a specific profile.
|
|
|
2313
2330
|
- **Method**: `GET`
|
|
2314
2331
|
- **Path**: `/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts`
|
|
2315
2332
|
|
|
2333
|
+
#### reach_getProfileSegmentDetailsV1
|
|
2334
|
+
|
|
2335
|
+
Get a single segment of a profile, including the conditions that define it.
|
|
2336
|
+
|
|
2337
|
+
To retrieve the contacts currently matching those conditions, use the segment contacts
|
|
2338
|
+
endpoint instead.
|
|
2339
|
+
|
|
2340
|
+
- **Method**: `GET`
|
|
2341
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}`
|
|
2342
|
+
|
|
2343
|
+
#### reach_updateAProfileSegmentV1
|
|
2344
|
+
|
|
2345
|
+
Rename a segment and/or replace the conditions that define it.
|
|
2346
|
+
|
|
2347
|
+
`name` is always required. Omit `conditions` to rename without touching the conditions;
|
|
2348
|
+
supply them and they replace the existing set entirely rather than being merged into it.
|
|
2349
|
+
Contacts are never modified, but which of them match the segment can change immediately.
|
|
2350
|
+
|
|
2351
|
+
- **Method**: `PUT`
|
|
2352
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}`
|
|
2353
|
+
|
|
2354
|
+
#### reach_deleteAProfileSegmentV1
|
|
2355
|
+
|
|
2356
|
+
Delete a segment.
|
|
2357
|
+
|
|
2358
|
+
Only the segment definition is removed. The contacts that matched it are left untouched.
|
|
2359
|
+
|
|
2360
|
+
- **Method**: `DELETE`
|
|
2361
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}`
|
|
2362
|
+
|
|
2363
|
+
#### reach_listProfileSegmentsV1
|
|
2364
|
+
|
|
2365
|
+
Get a paginated list of the segments defined in a profile.
|
|
2366
|
+
|
|
2367
|
+
Each entry carries the number of contacts currently matching it, which is recalculated on
|
|
2368
|
+
read rather than stored. Use `count_type` to count either every matching contact or only
|
|
2369
|
+
the subscribed ones.
|
|
2370
|
+
|
|
2371
|
+
- **Method**: `GET`
|
|
2372
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/segmentation/segments`
|
|
2373
|
+
|
|
2374
|
+
#### reach_createAProfileSegmentV1
|
|
2375
|
+
|
|
2376
|
+
Create a segment in a profile.
|
|
2377
|
+
|
|
2378
|
+
A segment is a saved set of conditions rather than a fixed list, so its membership changes
|
|
2379
|
+
as contacts change. Creating one does not modify any contact.
|
|
2380
|
+
|
|
2381
|
+
- **Method**: `POST`
|
|
2382
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/segmentation/segments`
|
|
2383
|
+
|
|
2316
2384
|
#### reach_listSegmentContactsV1
|
|
2317
2385
|
|
|
2318
2386
|
Retrieve contacts associated with a specific segment.
|
|
@@ -2320,6 +2388,10 @@ Retrieve contacts associated with a specific segment.
|
|
|
2320
2388
|
This endpoint allows you to fetch and filter contacts that belong to a particular segment,
|
|
2321
2389
|
identified by its UUID.
|
|
2322
2390
|
|
|
2391
|
+
**Deprecated.** This endpoint cannot target a profile, so it always falls back to
|
|
2392
|
+
the client's default profile and cannot read segments of any other profile. Use
|
|
2393
|
+
`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts` instead.
|
|
2394
|
+
|
|
2323
2395
|
- **Method**: `GET`
|
|
2324
2396
|
- **Path**: `/api/reach/v1/segmentation/segments/{segmentUuid}/contacts`
|
|
2325
2397
|
|
|
@@ -2330,6 +2402,10 @@ Get details of a specific segment.
|
|
|
2330
2402
|
This endpoint retrieves information about a single segment identified by UUID.
|
|
2331
2403
|
Segments are used to organize and group contacts based on specific criteria.
|
|
2332
2404
|
|
|
2405
|
+
**Deprecated.** This endpoint cannot target a profile, so it always falls back to
|
|
2406
|
+
the client's default profile and cannot read segments of any other profile. Use
|
|
2407
|
+
`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}` instead.
|
|
2408
|
+
|
|
2333
2409
|
- **Method**: `GET`
|
|
2334
2410
|
- **Path**: `/api/reach/v1/segmentation/segments/{segmentUuid}`
|
|
2335
2411
|
|
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.33.0",
|
|
10
10
|
"packages": [
|
|
11
11
|
{
|
|
12
12
|
"registryType": "npm",
|
|
13
13
|
"identifier": "hostinger-api-mcp",
|
|
14
|
-
"version": "1.
|
|
14
|
+
"version": "1.33.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
|
@@ -6754,7 +6754,7 @@ export default [
|
|
|
6754
6754
|
},
|
|
6755
6755
|
{
|
|
6756
6756
|
"name": "reach_listSegmentsV1",
|
|
6757
|
-
"description": "Get a list of all contact segments.\n\nThis endpoint returns a list of contact segments that can be used to organize contacts.",
|
|
6757
|
+
"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.",
|
|
6758
6758
|
"method": "GET",
|
|
6759
6759
|
"path": "/api/reach/v1/segmentation/segments",
|
|
6760
6760
|
"inputSchema": {
|
|
@@ -6771,7 +6771,7 @@ export default [
|
|
|
6771
6771
|
},
|
|
6772
6772
|
{
|
|
6773
6773
|
"name": "reach_createANewContactSegmentV1",
|
|
6774
|
-
"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.",
|
|
6774
|
+
"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.",
|
|
6775
6775
|
"method": "POST",
|
|
6776
6776
|
"path": "/api/reach/v1/segmentation/segments",
|
|
6777
6777
|
"inputSchema": {
|
|
@@ -6810,6 +6810,8 @@ export default [
|
|
|
6810
6810
|
"not_dropped",
|
|
6811
6811
|
"bounced",
|
|
6812
6812
|
"not_bounced",
|
|
6813
|
+
"soft_bounced",
|
|
6814
|
+
"not_soft_bounced",
|
|
6813
6815
|
"opened",
|
|
6814
6816
|
"not_opened",
|
|
6815
6817
|
"clicked",
|
|
@@ -6873,6 +6875,35 @@ export default [
|
|
|
6873
6875
|
],
|
|
6874
6876
|
"group": "reach"
|
|
6875
6877
|
},
|
|
6878
|
+
{
|
|
6879
|
+
"name": "reach_countProfileSegmentContactsV1",
|
|
6880
|
+
"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.",
|
|
6881
|
+
"method": "GET",
|
|
6882
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count",
|
|
6883
|
+
"inputSchema": {
|
|
6884
|
+
"type": "object",
|
|
6885
|
+
"properties": {
|
|
6886
|
+
"profileUuid": {
|
|
6887
|
+
"type": "string",
|
|
6888
|
+
"description": "Profile uuid parameter"
|
|
6889
|
+
},
|
|
6890
|
+
"segmentUuid": {
|
|
6891
|
+
"type": "string",
|
|
6892
|
+
"description": "Segment uuid parameter"
|
|
6893
|
+
}
|
|
6894
|
+
},
|
|
6895
|
+
"required": [
|
|
6896
|
+
"profileUuid",
|
|
6897
|
+
"segmentUuid"
|
|
6898
|
+
]
|
|
6899
|
+
},
|
|
6900
|
+
"security": [
|
|
6901
|
+
{
|
|
6902
|
+
"apiToken": []
|
|
6903
|
+
}
|
|
6904
|
+
],
|
|
6905
|
+
"group": "reach"
|
|
6906
|
+
},
|
|
6876
6907
|
{
|
|
6877
6908
|
"name": "reach_listProfileSegmentContactsV1",
|
|
6878
6909
|
"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.",
|
|
@@ -6910,9 +6941,298 @@ export default [
|
|
|
6910
6941
|
],
|
|
6911
6942
|
"group": "reach"
|
|
6912
6943
|
},
|
|
6944
|
+
{
|
|
6945
|
+
"name": "reach_getProfileSegmentDetailsV1",
|
|
6946
|
+
"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.",
|
|
6947
|
+
"method": "GET",
|
|
6948
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
6949
|
+
"inputSchema": {
|
|
6950
|
+
"type": "object",
|
|
6951
|
+
"properties": {
|
|
6952
|
+
"profileUuid": {
|
|
6953
|
+
"type": "string",
|
|
6954
|
+
"description": "Profile uuid parameter"
|
|
6955
|
+
},
|
|
6956
|
+
"segmentUuid": {
|
|
6957
|
+
"type": "string",
|
|
6958
|
+
"description": "Segment uuid parameter"
|
|
6959
|
+
}
|
|
6960
|
+
},
|
|
6961
|
+
"required": [
|
|
6962
|
+
"profileUuid",
|
|
6963
|
+
"segmentUuid"
|
|
6964
|
+
]
|
|
6965
|
+
},
|
|
6966
|
+
"security": [
|
|
6967
|
+
{
|
|
6968
|
+
"apiToken": []
|
|
6969
|
+
}
|
|
6970
|
+
],
|
|
6971
|
+
"group": "reach"
|
|
6972
|
+
},
|
|
6973
|
+
{
|
|
6974
|
+
"name": "reach_updateAProfileSegmentV1",
|
|
6975
|
+
"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.",
|
|
6976
|
+
"method": "PUT",
|
|
6977
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
6978
|
+
"inputSchema": {
|
|
6979
|
+
"type": "object",
|
|
6980
|
+
"properties": {
|
|
6981
|
+
"profileUuid": {
|
|
6982
|
+
"type": "string",
|
|
6983
|
+
"description": "Profile uuid parameter"
|
|
6984
|
+
},
|
|
6985
|
+
"segmentUuid": {
|
|
6986
|
+
"type": "string",
|
|
6987
|
+
"description": "Segment uuid parameter"
|
|
6988
|
+
},
|
|
6989
|
+
"name": {
|
|
6990
|
+
"type": "string",
|
|
6991
|
+
"description": "name parameter"
|
|
6992
|
+
},
|
|
6993
|
+
"conditions": {
|
|
6994
|
+
"type": "array",
|
|
6995
|
+
"description": "Replaces the existing conditions entirely. Omit to keep the current ones.",
|
|
6996
|
+
"items": {
|
|
6997
|
+
"type": "object",
|
|
6998
|
+
"description": "conditions parameter",
|
|
6999
|
+
"properties": {
|
|
7000
|
+
"attribute": {
|
|
7001
|
+
"type": "string",
|
|
7002
|
+
"description": "A built-in contact attribute, or `cf:{fieldUuid}` to target a custom\ncontact field. Custom fields are addressed by field UUID; their slug\nis not accepted.\n\nBuilt-in attributes: `email`, `note`, `domain`, `source`,\n`opt_in_method`, `subscription_status`, `subscribed_at`,\n`unsubscribed_at`, `created_at`, `tag`, `campaigns`, `processed`,\n`opened`, `clicked`, `delivered`, `bounced`, `soft_bounced`,\n`dropped`.\n\nWhich operators are accepted depends on the attribute."
|
|
7003
|
+
},
|
|
7004
|
+
"operator": {
|
|
7005
|
+
"type": "string",
|
|
7006
|
+
"description": "operator parameter",
|
|
7007
|
+
"enum": [
|
|
7008
|
+
"equals",
|
|
7009
|
+
"not_equals",
|
|
7010
|
+
"contains",
|
|
7011
|
+
"not_contains",
|
|
7012
|
+
"gte",
|
|
7013
|
+
"lte",
|
|
7014
|
+
"exists",
|
|
7015
|
+
"within_last_days",
|
|
7016
|
+
"not_within_last_days",
|
|
7017
|
+
"older_than_days",
|
|
7018
|
+
"processed",
|
|
7019
|
+
"not_processed",
|
|
7020
|
+
"delivered",
|
|
7021
|
+
"not_delivered",
|
|
7022
|
+
"dropped",
|
|
7023
|
+
"not_dropped",
|
|
7024
|
+
"bounced",
|
|
7025
|
+
"not_bounced",
|
|
7026
|
+
"soft_bounced",
|
|
7027
|
+
"not_soft_bounced",
|
|
7028
|
+
"opened",
|
|
7029
|
+
"not_opened",
|
|
7030
|
+
"clicked",
|
|
7031
|
+
"not_clicked",
|
|
7032
|
+
"unsubscribed",
|
|
7033
|
+
"not_unsubscribed"
|
|
7034
|
+
]
|
|
7035
|
+
},
|
|
7036
|
+
"value": {
|
|
7037
|
+
"type": "string",
|
|
7038
|
+
"description": "Always a string, including for numeric and date comparisons"
|
|
7039
|
+
}
|
|
7040
|
+
},
|
|
7041
|
+
"required": [
|
|
7042
|
+
"attribute",
|
|
7043
|
+
"operator",
|
|
7044
|
+
"value"
|
|
7045
|
+
]
|
|
7046
|
+
}
|
|
7047
|
+
},
|
|
7048
|
+
"logic": {
|
|
7049
|
+
"type": "string",
|
|
7050
|
+
"description": "How to combine multiple conditions. Required when conditions are given.",
|
|
7051
|
+
"enum": [
|
|
7052
|
+
"AND",
|
|
7053
|
+
"OR"
|
|
7054
|
+
]
|
|
7055
|
+
}
|
|
7056
|
+
},
|
|
7057
|
+
"required": [
|
|
7058
|
+
"profileUuid",
|
|
7059
|
+
"segmentUuid",
|
|
7060
|
+
"name"
|
|
7061
|
+
]
|
|
7062
|
+
},
|
|
7063
|
+
"security": [
|
|
7064
|
+
{
|
|
7065
|
+
"apiToken": []
|
|
7066
|
+
}
|
|
7067
|
+
],
|
|
7068
|
+
"group": "reach"
|
|
7069
|
+
},
|
|
7070
|
+
{
|
|
7071
|
+
"name": "reach_deleteAProfileSegmentV1",
|
|
7072
|
+
"description": "Delete a segment.\n\nOnly the segment definition is removed. The contacts that matched it are left untouched.",
|
|
7073
|
+
"method": "DELETE",
|
|
7074
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
7075
|
+
"inputSchema": {
|
|
7076
|
+
"type": "object",
|
|
7077
|
+
"properties": {
|
|
7078
|
+
"profileUuid": {
|
|
7079
|
+
"type": "string",
|
|
7080
|
+
"description": "Profile uuid parameter"
|
|
7081
|
+
},
|
|
7082
|
+
"segmentUuid": {
|
|
7083
|
+
"type": "string",
|
|
7084
|
+
"description": "Segment uuid parameter"
|
|
7085
|
+
}
|
|
7086
|
+
},
|
|
7087
|
+
"required": [
|
|
7088
|
+
"profileUuid",
|
|
7089
|
+
"segmentUuid"
|
|
7090
|
+
]
|
|
7091
|
+
},
|
|
7092
|
+
"security": [
|
|
7093
|
+
{
|
|
7094
|
+
"apiToken": []
|
|
7095
|
+
}
|
|
7096
|
+
],
|
|
7097
|
+
"group": "reach"
|
|
7098
|
+
},
|
|
7099
|
+
{
|
|
7100
|
+
"name": "reach_listProfileSegmentsV1",
|
|
7101
|
+
"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.",
|
|
7102
|
+
"method": "GET",
|
|
7103
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments",
|
|
7104
|
+
"inputSchema": {
|
|
7105
|
+
"type": "object",
|
|
7106
|
+
"properties": {
|
|
7107
|
+
"profileUuid": {
|
|
7108
|
+
"type": "string",
|
|
7109
|
+
"description": "Profile uuid parameter"
|
|
7110
|
+
},
|
|
7111
|
+
"count_type": {
|
|
7112
|
+
"type": "string",
|
|
7113
|
+
"description": "Which matching contacts to count for each segment",
|
|
7114
|
+
"enum": [
|
|
7115
|
+
"all",
|
|
7116
|
+
"subscribed"
|
|
7117
|
+
]
|
|
7118
|
+
},
|
|
7119
|
+
"page": {
|
|
7120
|
+
"type": "integer",
|
|
7121
|
+
"description": "Page number"
|
|
7122
|
+
},
|
|
7123
|
+
"per_page": {
|
|
7124
|
+
"type": "integer",
|
|
7125
|
+
"description": "Number of items per page"
|
|
7126
|
+
}
|
|
7127
|
+
},
|
|
7128
|
+
"required": [
|
|
7129
|
+
"profileUuid"
|
|
7130
|
+
]
|
|
7131
|
+
},
|
|
7132
|
+
"security": [
|
|
7133
|
+
{
|
|
7134
|
+
"apiToken": []
|
|
7135
|
+
}
|
|
7136
|
+
],
|
|
7137
|
+
"group": "reach"
|
|
7138
|
+
},
|
|
7139
|
+
{
|
|
7140
|
+
"name": "reach_createAProfileSegmentV1",
|
|
7141
|
+
"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.",
|
|
7142
|
+
"method": "POST",
|
|
7143
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments",
|
|
7144
|
+
"inputSchema": {
|
|
7145
|
+
"type": "object",
|
|
7146
|
+
"properties": {
|
|
7147
|
+
"profileUuid": {
|
|
7148
|
+
"type": "string",
|
|
7149
|
+
"description": "Profile uuid parameter"
|
|
7150
|
+
},
|
|
7151
|
+
"name": {
|
|
7152
|
+
"type": "string",
|
|
7153
|
+
"description": "name parameter"
|
|
7154
|
+
},
|
|
7155
|
+
"conditions": {
|
|
7156
|
+
"type": "array",
|
|
7157
|
+
"description": "Conditions a contact must satisfy to fall into the segment",
|
|
7158
|
+
"items": {
|
|
7159
|
+
"type": "object",
|
|
7160
|
+
"description": "conditions parameter",
|
|
7161
|
+
"properties": {
|
|
7162
|
+
"attribute": {
|
|
7163
|
+
"type": "string",
|
|
7164
|
+
"description": "A built-in contact attribute, or `cf:{fieldUuid}` to target a custom\ncontact field. Custom fields are addressed by field UUID; their slug\nis not accepted.\n\nBuilt-in attributes: `email`, `note`, `domain`, `source`,\n`opt_in_method`, `subscription_status`, `subscribed_at`,\n`unsubscribed_at`, `created_at`, `tag`, `campaigns`, `processed`,\n`opened`, `clicked`, `delivered`, `bounced`, `soft_bounced`,\n`dropped`.\n\nWhich operators are accepted depends on the attribute."
|
|
7165
|
+
},
|
|
7166
|
+
"operator": {
|
|
7167
|
+
"type": "string",
|
|
7168
|
+
"description": "operator parameter",
|
|
7169
|
+
"enum": [
|
|
7170
|
+
"equals",
|
|
7171
|
+
"not_equals",
|
|
7172
|
+
"contains",
|
|
7173
|
+
"not_contains",
|
|
7174
|
+
"gte",
|
|
7175
|
+
"lte",
|
|
7176
|
+
"exists",
|
|
7177
|
+
"within_last_days",
|
|
7178
|
+
"not_within_last_days",
|
|
7179
|
+
"older_than_days",
|
|
7180
|
+
"processed",
|
|
7181
|
+
"not_processed",
|
|
7182
|
+
"delivered",
|
|
7183
|
+
"not_delivered",
|
|
7184
|
+
"dropped",
|
|
7185
|
+
"not_dropped",
|
|
7186
|
+
"bounced",
|
|
7187
|
+
"not_bounced",
|
|
7188
|
+
"soft_bounced",
|
|
7189
|
+
"not_soft_bounced",
|
|
7190
|
+
"opened",
|
|
7191
|
+
"not_opened",
|
|
7192
|
+
"clicked",
|
|
7193
|
+
"not_clicked",
|
|
7194
|
+
"unsubscribed",
|
|
7195
|
+
"not_unsubscribed"
|
|
7196
|
+
]
|
|
7197
|
+
},
|
|
7198
|
+
"value": {
|
|
7199
|
+
"type": "string",
|
|
7200
|
+
"description": "Always a string, including for numeric and date comparisons"
|
|
7201
|
+
}
|
|
7202
|
+
},
|
|
7203
|
+
"required": [
|
|
7204
|
+
"attribute",
|
|
7205
|
+
"operator",
|
|
7206
|
+
"value"
|
|
7207
|
+
]
|
|
7208
|
+
}
|
|
7209
|
+
},
|
|
7210
|
+
"logic": {
|
|
7211
|
+
"type": "string",
|
|
7212
|
+
"description": "How to combine multiple conditions",
|
|
7213
|
+
"enum": [
|
|
7214
|
+
"AND",
|
|
7215
|
+
"OR"
|
|
7216
|
+
]
|
|
7217
|
+
}
|
|
7218
|
+
},
|
|
7219
|
+
"required": [
|
|
7220
|
+
"profileUuid",
|
|
7221
|
+
"name",
|
|
7222
|
+
"conditions",
|
|
7223
|
+
"logic"
|
|
7224
|
+
]
|
|
7225
|
+
},
|
|
7226
|
+
"security": [
|
|
7227
|
+
{
|
|
7228
|
+
"apiToken": []
|
|
7229
|
+
}
|
|
7230
|
+
],
|
|
7231
|
+
"group": "reach"
|
|
7232
|
+
},
|
|
6913
7233
|
{
|
|
6914
7234
|
"name": "reach_listSegmentContactsV1",
|
|
6915
|
-
"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.",
|
|
7235
|
+
"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.",
|
|
6916
7236
|
"method": "GET",
|
|
6917
7237
|
"path": "/api/reach/v1/segmentation/segments/{segmentUuid}/contacts",
|
|
6918
7238
|
"inputSchema": {
|
|
@@ -6944,7 +7264,7 @@ export default [
|
|
|
6944
7264
|
},
|
|
6945
7265
|
{
|
|
6946
7266
|
"name": "reach_getSegmentDetailsV1",
|
|
6947
|
-
"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.",
|
|
7267
|
+
"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.",
|
|
6948
7268
|
"method": "GET",
|
|
6949
7269
|
"path": "/api/reach/v1/segmentation/segments/{segmentUuid}",
|
|
6950
7270
|
"inputSchema": {
|