hostinger-api-mcp 1.31.0 → 1.32.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 +85 -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 +258 -0
- package/src/core/tools/all.ts +258 -0
- package/src/core/tools/reach.js +258 -0
- package/src/core/tools/reach.ts +258 -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 +179 -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 (308 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` — 29 tools for reach
|
|
62
62
|
- `hostinger-vps-mcp` — 62 tools for vps
|
|
63
63
|
- `hostinger-wordpress-mcp` — 35 tools for wordpress
|
|
64
64
|
|
|
@@ -2333,6 +2333,89 @@ Segments are used to organize and group contacts based on specific criteria.
|
|
|
2333
2333
|
- **Method**: `GET`
|
|
2334
2334
|
- **Path**: `/api/reach/v1/segmentation/segments/{segmentUuid}`
|
|
2335
2335
|
|
|
2336
|
+
#### reach_assignAContactToATagV1
|
|
2337
|
+
|
|
2338
|
+
Assign a tag to a single contact.
|
|
2339
|
+
|
|
2340
|
+
Unlike the bulk endpoint this is applied immediately rather than queued. Assigning a tag
|
|
2341
|
+
the contact already carries succeeds without duplicating it.
|
|
2342
|
+
|
|
2343
|
+
- **Method**: `POST`
|
|
2344
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}`
|
|
2345
|
+
|
|
2346
|
+
#### reach_removeAContactFromATagV1
|
|
2347
|
+
|
|
2348
|
+
Remove a tag from a single contact.
|
|
2349
|
+
|
|
2350
|
+
Unlike the bulk endpoint this is applied immediately rather than queued. Neither the tag
|
|
2351
|
+
nor the contact is deleted.
|
|
2352
|
+
|
|
2353
|
+
- **Method**: `DELETE`
|
|
2354
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}`
|
|
2355
|
+
|
|
2356
|
+
#### reach_assignContactsToATagV1
|
|
2357
|
+
|
|
2358
|
+
Assign a tag to many contacts at once.
|
|
2359
|
+
|
|
2360
|
+
Pass `contact_uuids` to target specific contacts, or `all_contacts` to target every contact
|
|
2361
|
+
in the profile. The work is queued, so a success response means it was accepted rather than
|
|
2362
|
+
finished. Contacts that already carry the tag are left alone.
|
|
2363
|
+
|
|
2364
|
+
- **Method**: `POST`
|
|
2365
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts`
|
|
2366
|
+
|
|
2367
|
+
#### reach_removeContactsFromATagV1
|
|
2368
|
+
|
|
2369
|
+
Remove a tag from many contacts at once.
|
|
2370
|
+
|
|
2371
|
+
Pass `contact_uuids` to target specific contacts, or `all_contacts` to target every contact
|
|
2372
|
+
in the profile. The work is queued, so a success response means it was accepted rather than
|
|
2373
|
+
finished. The tag itself and the contacts are not deleted.
|
|
2374
|
+
|
|
2375
|
+
- **Method**: `DELETE`
|
|
2376
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts`
|
|
2377
|
+
|
|
2378
|
+
#### reach_deleteATagV1
|
|
2379
|
+
|
|
2380
|
+
Delete a tag and remove it from every contact carrying it.
|
|
2381
|
+
|
|
2382
|
+
The contacts themselves are not deleted. This is idempotent: deleting a tag that does not
|
|
2383
|
+
exist in the profile still succeeds.
|
|
2384
|
+
|
|
2385
|
+
- **Method**: `DELETE`
|
|
2386
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}`
|
|
2387
|
+
|
|
2388
|
+
#### reach_renameATagV1
|
|
2389
|
+
|
|
2390
|
+
Rename a tag.
|
|
2391
|
+
|
|
2392
|
+
The contacts assigned to the tag are unaffected. Names are unique within a profile, so
|
|
2393
|
+
renaming a tag to a name that is already taken is rejected.
|
|
2394
|
+
|
|
2395
|
+
- **Method**: `PATCH`
|
|
2396
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}`
|
|
2397
|
+
|
|
2398
|
+
#### reach_listProfileTagsV1
|
|
2399
|
+
|
|
2400
|
+
Get all tags defined in a profile.
|
|
2401
|
+
|
|
2402
|
+
Tags are the way contacts are grouped in Reach, and can be used to filter the contact
|
|
2403
|
+
list or to build segments.
|
|
2404
|
+
|
|
2405
|
+
- **Method**: `GET`
|
|
2406
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags`
|
|
2407
|
+
|
|
2408
|
+
#### reach_createOrFindTagsV1
|
|
2409
|
+
|
|
2410
|
+
Create tags in a profile.
|
|
2411
|
+
|
|
2412
|
+
Names that already exist in the profile are not duplicated: the existing tag is returned
|
|
2413
|
+
instead, so the call is safe to repeat. Every tag in the request is returned, whether it
|
|
2414
|
+
was created now or already existed.
|
|
2415
|
+
|
|
2416
|
+
- **Method**: `POST`
|
|
2417
|
+
- **Path**: `/api/reach/v1/profiles/{profileUuid}/tags`
|
|
2418
|
+
|
|
2336
2419
|
#### reach_getProfileDomainDNSStatusV1
|
|
2337
2420
|
|
|
2338
2421
|
Retrieve the DNS configuration status for a profile's domain.
|
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.32.0",
|
|
10
10
|
"packages": [
|
|
11
11
|
{
|
|
12
12
|
"registryType": "npm",
|
|
13
13
|
"identifier": "hostinger-api-mcp",
|
|
14
|
-
"version": "1.
|
|
14
|
+
"version": "1.32.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
|
@@ -6966,6 +6966,264 @@ export default [
|
|
|
6966
6966
|
],
|
|
6967
6967
|
"group": "reach"
|
|
6968
6968
|
},
|
|
6969
|
+
{
|
|
6970
|
+
"name": "reach_assignAContactToATagV1",
|
|
6971
|
+
"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.",
|
|
6972
|
+
"method": "POST",
|
|
6973
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
6974
|
+
"inputSchema": {
|
|
6975
|
+
"type": "object",
|
|
6976
|
+
"properties": {
|
|
6977
|
+
"profileUuid": {
|
|
6978
|
+
"type": "string",
|
|
6979
|
+
"description": "Profile uuid parameter"
|
|
6980
|
+
},
|
|
6981
|
+
"tagUuid": {
|
|
6982
|
+
"type": "string",
|
|
6983
|
+
"description": "Tag uuid parameter"
|
|
6984
|
+
},
|
|
6985
|
+
"contactUuid": {
|
|
6986
|
+
"type": "string",
|
|
6987
|
+
"description": "Contact uuid parameter"
|
|
6988
|
+
}
|
|
6989
|
+
},
|
|
6990
|
+
"required": [
|
|
6991
|
+
"profileUuid",
|
|
6992
|
+
"tagUuid",
|
|
6993
|
+
"contactUuid"
|
|
6994
|
+
]
|
|
6995
|
+
},
|
|
6996
|
+
"security": [
|
|
6997
|
+
{
|
|
6998
|
+
"apiToken": []
|
|
6999
|
+
}
|
|
7000
|
+
],
|
|
7001
|
+
"group": "reach"
|
|
7002
|
+
},
|
|
7003
|
+
{
|
|
7004
|
+
"name": "reach_removeAContactFromATagV1",
|
|
7005
|
+
"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.",
|
|
7006
|
+
"method": "DELETE",
|
|
7007
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
7008
|
+
"inputSchema": {
|
|
7009
|
+
"type": "object",
|
|
7010
|
+
"properties": {
|
|
7011
|
+
"profileUuid": {
|
|
7012
|
+
"type": "string",
|
|
7013
|
+
"description": "Profile uuid parameter"
|
|
7014
|
+
},
|
|
7015
|
+
"tagUuid": {
|
|
7016
|
+
"type": "string",
|
|
7017
|
+
"description": "Tag uuid parameter"
|
|
7018
|
+
},
|
|
7019
|
+
"contactUuid": {
|
|
7020
|
+
"type": "string",
|
|
7021
|
+
"description": "Contact uuid parameter"
|
|
7022
|
+
}
|
|
7023
|
+
},
|
|
7024
|
+
"required": [
|
|
7025
|
+
"profileUuid",
|
|
7026
|
+
"tagUuid",
|
|
7027
|
+
"contactUuid"
|
|
7028
|
+
]
|
|
7029
|
+
},
|
|
7030
|
+
"security": [
|
|
7031
|
+
{
|
|
7032
|
+
"apiToken": []
|
|
7033
|
+
}
|
|
7034
|
+
],
|
|
7035
|
+
"group": "reach"
|
|
7036
|
+
},
|
|
7037
|
+
{
|
|
7038
|
+
"name": "reach_assignContactsToATagV1",
|
|
7039
|
+
"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.",
|
|
7040
|
+
"method": "POST",
|
|
7041
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
7042
|
+
"inputSchema": {
|
|
7043
|
+
"type": "object",
|
|
7044
|
+
"properties": {
|
|
7045
|
+
"profileUuid": {
|
|
7046
|
+
"type": "string",
|
|
7047
|
+
"description": "Profile uuid parameter"
|
|
7048
|
+
},
|
|
7049
|
+
"tagUuid": {
|
|
7050
|
+
"type": "string",
|
|
7051
|
+
"description": "Tag uuid parameter"
|
|
7052
|
+
},
|
|
7053
|
+
"contact_uuids": {
|
|
7054
|
+
"type": "array",
|
|
7055
|
+
"description": "Contacts to apply the change to. Required unless all_contacts is true.",
|
|
7056
|
+
"items": {
|
|
7057
|
+
"type": "string",
|
|
7058
|
+
"description": "contact_uuids parameter"
|
|
7059
|
+
}
|
|
7060
|
+
},
|
|
7061
|
+
"all_contacts": {
|
|
7062
|
+
"type": "boolean",
|
|
7063
|
+
"description": "Apply to every contact in the profile"
|
|
7064
|
+
}
|
|
7065
|
+
},
|
|
7066
|
+
"required": [
|
|
7067
|
+
"profileUuid",
|
|
7068
|
+
"tagUuid"
|
|
7069
|
+
]
|
|
7070
|
+
},
|
|
7071
|
+
"security": [
|
|
7072
|
+
{
|
|
7073
|
+
"apiToken": []
|
|
7074
|
+
}
|
|
7075
|
+
],
|
|
7076
|
+
"group": "reach"
|
|
7077
|
+
},
|
|
7078
|
+
{
|
|
7079
|
+
"name": "reach_removeContactsFromATagV1",
|
|
7080
|
+
"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.",
|
|
7081
|
+
"method": "DELETE",
|
|
7082
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
7083
|
+
"inputSchema": {
|
|
7084
|
+
"type": "object",
|
|
7085
|
+
"properties": {
|
|
7086
|
+
"profileUuid": {
|
|
7087
|
+
"type": "string",
|
|
7088
|
+
"description": "Profile uuid parameter"
|
|
7089
|
+
},
|
|
7090
|
+
"tagUuid": {
|
|
7091
|
+
"type": "string",
|
|
7092
|
+
"description": "Tag uuid parameter"
|
|
7093
|
+
}
|
|
7094
|
+
},
|
|
7095
|
+
"required": [
|
|
7096
|
+
"profileUuid",
|
|
7097
|
+
"tagUuid"
|
|
7098
|
+
]
|
|
7099
|
+
},
|
|
7100
|
+
"security": [
|
|
7101
|
+
{
|
|
7102
|
+
"apiToken": []
|
|
7103
|
+
}
|
|
7104
|
+
],
|
|
7105
|
+
"group": "reach"
|
|
7106
|
+
},
|
|
7107
|
+
{
|
|
7108
|
+
"name": "reach_deleteATagV1",
|
|
7109
|
+
"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.",
|
|
7110
|
+
"method": "DELETE",
|
|
7111
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
7112
|
+
"inputSchema": {
|
|
7113
|
+
"type": "object",
|
|
7114
|
+
"properties": {
|
|
7115
|
+
"profileUuid": {
|
|
7116
|
+
"type": "string",
|
|
7117
|
+
"description": "Profile uuid parameter"
|
|
7118
|
+
},
|
|
7119
|
+
"tagUuid": {
|
|
7120
|
+
"type": "string",
|
|
7121
|
+
"description": "Tag uuid parameter"
|
|
7122
|
+
}
|
|
7123
|
+
},
|
|
7124
|
+
"required": [
|
|
7125
|
+
"profileUuid",
|
|
7126
|
+
"tagUuid"
|
|
7127
|
+
]
|
|
7128
|
+
},
|
|
7129
|
+
"security": [
|
|
7130
|
+
{
|
|
7131
|
+
"apiToken": []
|
|
7132
|
+
}
|
|
7133
|
+
],
|
|
7134
|
+
"group": "reach"
|
|
7135
|
+
},
|
|
7136
|
+
{
|
|
7137
|
+
"name": "reach_renameATagV1",
|
|
7138
|
+
"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.",
|
|
7139
|
+
"method": "PATCH",
|
|
7140
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
7141
|
+
"inputSchema": {
|
|
7142
|
+
"type": "object",
|
|
7143
|
+
"properties": {
|
|
7144
|
+
"profileUuid": {
|
|
7145
|
+
"type": "string",
|
|
7146
|
+
"description": "Profile uuid parameter"
|
|
7147
|
+
},
|
|
7148
|
+
"tagUuid": {
|
|
7149
|
+
"type": "string",
|
|
7150
|
+
"description": "Tag uuid parameter"
|
|
7151
|
+
},
|
|
7152
|
+
"value": {
|
|
7153
|
+
"type": "string",
|
|
7154
|
+
"description": "New tag name"
|
|
7155
|
+
}
|
|
7156
|
+
},
|
|
7157
|
+
"required": [
|
|
7158
|
+
"profileUuid",
|
|
7159
|
+
"tagUuid",
|
|
7160
|
+
"value"
|
|
7161
|
+
]
|
|
7162
|
+
},
|
|
7163
|
+
"security": [
|
|
7164
|
+
{
|
|
7165
|
+
"apiToken": []
|
|
7166
|
+
}
|
|
7167
|
+
],
|
|
7168
|
+
"group": "reach"
|
|
7169
|
+
},
|
|
7170
|
+
{
|
|
7171
|
+
"name": "reach_listProfileTagsV1",
|
|
7172
|
+
"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.",
|
|
7173
|
+
"method": "GET",
|
|
7174
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
7175
|
+
"inputSchema": {
|
|
7176
|
+
"type": "object",
|
|
7177
|
+
"properties": {
|
|
7178
|
+
"profileUuid": {
|
|
7179
|
+
"type": "string",
|
|
7180
|
+
"description": "Profile uuid parameter"
|
|
7181
|
+
}
|
|
7182
|
+
},
|
|
7183
|
+
"required": [
|
|
7184
|
+
"profileUuid"
|
|
7185
|
+
]
|
|
7186
|
+
},
|
|
7187
|
+
"security": [
|
|
7188
|
+
{
|
|
7189
|
+
"apiToken": []
|
|
7190
|
+
}
|
|
7191
|
+
],
|
|
7192
|
+
"group": "reach"
|
|
7193
|
+
},
|
|
7194
|
+
{
|
|
7195
|
+
"name": "reach_createOrFindTagsV1",
|
|
7196
|
+
"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.",
|
|
7197
|
+
"method": "POST",
|
|
7198
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
7199
|
+
"inputSchema": {
|
|
7200
|
+
"type": "object",
|
|
7201
|
+
"properties": {
|
|
7202
|
+
"profileUuid": {
|
|
7203
|
+
"type": "string",
|
|
7204
|
+
"description": "Profile uuid parameter"
|
|
7205
|
+
},
|
|
7206
|
+
"names": {
|
|
7207
|
+
"type": "array",
|
|
7208
|
+
"description": "names parameter",
|
|
7209
|
+
"items": {
|
|
7210
|
+
"type": "string",
|
|
7211
|
+
"description": "names parameter"
|
|
7212
|
+
}
|
|
7213
|
+
}
|
|
7214
|
+
},
|
|
7215
|
+
"required": [
|
|
7216
|
+
"profileUuid",
|
|
7217
|
+
"names"
|
|
7218
|
+
]
|
|
7219
|
+
},
|
|
7220
|
+
"security": [
|
|
7221
|
+
{
|
|
7222
|
+
"apiToken": []
|
|
7223
|
+
}
|
|
7224
|
+
],
|
|
7225
|
+
"group": "reach"
|
|
7226
|
+
},
|
|
6969
7227
|
{
|
|
6970
7228
|
"name": "reach_getProfileDomainDNSStatusV1",
|
|
6971
7229
|
"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.",
|
package/src/core/tools/all.ts
CHANGED
|
@@ -6980,6 +6980,264 @@ const tools: OpenApiTool[] = [
|
|
|
6980
6980
|
],
|
|
6981
6981
|
"group": "reach"
|
|
6982
6982
|
},
|
|
6983
|
+
{
|
|
6984
|
+
"name": "reach_assignAContactToATagV1",
|
|
6985
|
+
"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.",
|
|
6986
|
+
"method": "POST",
|
|
6987
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
6988
|
+
"inputSchema": {
|
|
6989
|
+
"type": "object",
|
|
6990
|
+
"properties": {
|
|
6991
|
+
"profileUuid": {
|
|
6992
|
+
"type": "string",
|
|
6993
|
+
"description": "Profile uuid parameter"
|
|
6994
|
+
},
|
|
6995
|
+
"tagUuid": {
|
|
6996
|
+
"type": "string",
|
|
6997
|
+
"description": "Tag uuid parameter"
|
|
6998
|
+
},
|
|
6999
|
+
"contactUuid": {
|
|
7000
|
+
"type": "string",
|
|
7001
|
+
"description": "Contact uuid parameter"
|
|
7002
|
+
}
|
|
7003
|
+
},
|
|
7004
|
+
"required": [
|
|
7005
|
+
"profileUuid",
|
|
7006
|
+
"tagUuid",
|
|
7007
|
+
"contactUuid"
|
|
7008
|
+
]
|
|
7009
|
+
},
|
|
7010
|
+
"security": [
|
|
7011
|
+
{
|
|
7012
|
+
"apiToken": []
|
|
7013
|
+
}
|
|
7014
|
+
],
|
|
7015
|
+
"group": "reach"
|
|
7016
|
+
},
|
|
7017
|
+
{
|
|
7018
|
+
"name": "reach_removeAContactFromATagV1",
|
|
7019
|
+
"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.",
|
|
7020
|
+
"method": "DELETE",
|
|
7021
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
7022
|
+
"inputSchema": {
|
|
7023
|
+
"type": "object",
|
|
7024
|
+
"properties": {
|
|
7025
|
+
"profileUuid": {
|
|
7026
|
+
"type": "string",
|
|
7027
|
+
"description": "Profile uuid parameter"
|
|
7028
|
+
},
|
|
7029
|
+
"tagUuid": {
|
|
7030
|
+
"type": "string",
|
|
7031
|
+
"description": "Tag uuid parameter"
|
|
7032
|
+
},
|
|
7033
|
+
"contactUuid": {
|
|
7034
|
+
"type": "string",
|
|
7035
|
+
"description": "Contact uuid parameter"
|
|
7036
|
+
}
|
|
7037
|
+
},
|
|
7038
|
+
"required": [
|
|
7039
|
+
"profileUuid",
|
|
7040
|
+
"tagUuid",
|
|
7041
|
+
"contactUuid"
|
|
7042
|
+
]
|
|
7043
|
+
},
|
|
7044
|
+
"security": [
|
|
7045
|
+
{
|
|
7046
|
+
"apiToken": []
|
|
7047
|
+
}
|
|
7048
|
+
],
|
|
7049
|
+
"group": "reach"
|
|
7050
|
+
},
|
|
7051
|
+
{
|
|
7052
|
+
"name": "reach_assignContactsToATagV1",
|
|
7053
|
+
"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.",
|
|
7054
|
+
"method": "POST",
|
|
7055
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
7056
|
+
"inputSchema": {
|
|
7057
|
+
"type": "object",
|
|
7058
|
+
"properties": {
|
|
7059
|
+
"profileUuid": {
|
|
7060
|
+
"type": "string",
|
|
7061
|
+
"description": "Profile uuid parameter"
|
|
7062
|
+
},
|
|
7063
|
+
"tagUuid": {
|
|
7064
|
+
"type": "string",
|
|
7065
|
+
"description": "Tag uuid parameter"
|
|
7066
|
+
},
|
|
7067
|
+
"contact_uuids": {
|
|
7068
|
+
"type": "array",
|
|
7069
|
+
"description": "Contacts to apply the change to. Required unless all_contacts is true.",
|
|
7070
|
+
"items": {
|
|
7071
|
+
"type": "string",
|
|
7072
|
+
"description": "contact_uuids parameter"
|
|
7073
|
+
}
|
|
7074
|
+
},
|
|
7075
|
+
"all_contacts": {
|
|
7076
|
+
"type": "boolean",
|
|
7077
|
+
"description": "Apply to every contact in the profile"
|
|
7078
|
+
}
|
|
7079
|
+
},
|
|
7080
|
+
"required": [
|
|
7081
|
+
"profileUuid",
|
|
7082
|
+
"tagUuid"
|
|
7083
|
+
]
|
|
7084
|
+
},
|
|
7085
|
+
"security": [
|
|
7086
|
+
{
|
|
7087
|
+
"apiToken": []
|
|
7088
|
+
}
|
|
7089
|
+
],
|
|
7090
|
+
"group": "reach"
|
|
7091
|
+
},
|
|
7092
|
+
{
|
|
7093
|
+
"name": "reach_removeContactsFromATagV1",
|
|
7094
|
+
"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.",
|
|
7095
|
+
"method": "DELETE",
|
|
7096
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
7097
|
+
"inputSchema": {
|
|
7098
|
+
"type": "object",
|
|
7099
|
+
"properties": {
|
|
7100
|
+
"profileUuid": {
|
|
7101
|
+
"type": "string",
|
|
7102
|
+
"description": "Profile uuid parameter"
|
|
7103
|
+
},
|
|
7104
|
+
"tagUuid": {
|
|
7105
|
+
"type": "string",
|
|
7106
|
+
"description": "Tag uuid parameter"
|
|
7107
|
+
}
|
|
7108
|
+
},
|
|
7109
|
+
"required": [
|
|
7110
|
+
"profileUuid",
|
|
7111
|
+
"tagUuid"
|
|
7112
|
+
]
|
|
7113
|
+
},
|
|
7114
|
+
"security": [
|
|
7115
|
+
{
|
|
7116
|
+
"apiToken": []
|
|
7117
|
+
}
|
|
7118
|
+
],
|
|
7119
|
+
"group": "reach"
|
|
7120
|
+
},
|
|
7121
|
+
{
|
|
7122
|
+
"name": "reach_deleteATagV1",
|
|
7123
|
+
"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.",
|
|
7124
|
+
"method": "DELETE",
|
|
7125
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
7126
|
+
"inputSchema": {
|
|
7127
|
+
"type": "object",
|
|
7128
|
+
"properties": {
|
|
7129
|
+
"profileUuid": {
|
|
7130
|
+
"type": "string",
|
|
7131
|
+
"description": "Profile uuid parameter"
|
|
7132
|
+
},
|
|
7133
|
+
"tagUuid": {
|
|
7134
|
+
"type": "string",
|
|
7135
|
+
"description": "Tag uuid parameter"
|
|
7136
|
+
}
|
|
7137
|
+
},
|
|
7138
|
+
"required": [
|
|
7139
|
+
"profileUuid",
|
|
7140
|
+
"tagUuid"
|
|
7141
|
+
]
|
|
7142
|
+
},
|
|
7143
|
+
"security": [
|
|
7144
|
+
{
|
|
7145
|
+
"apiToken": []
|
|
7146
|
+
}
|
|
7147
|
+
],
|
|
7148
|
+
"group": "reach"
|
|
7149
|
+
},
|
|
7150
|
+
{
|
|
7151
|
+
"name": "reach_renameATagV1",
|
|
7152
|
+
"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.",
|
|
7153
|
+
"method": "PATCH",
|
|
7154
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
7155
|
+
"inputSchema": {
|
|
7156
|
+
"type": "object",
|
|
7157
|
+
"properties": {
|
|
7158
|
+
"profileUuid": {
|
|
7159
|
+
"type": "string",
|
|
7160
|
+
"description": "Profile uuid parameter"
|
|
7161
|
+
},
|
|
7162
|
+
"tagUuid": {
|
|
7163
|
+
"type": "string",
|
|
7164
|
+
"description": "Tag uuid parameter"
|
|
7165
|
+
},
|
|
7166
|
+
"value": {
|
|
7167
|
+
"type": "string",
|
|
7168
|
+
"description": "New tag name"
|
|
7169
|
+
}
|
|
7170
|
+
},
|
|
7171
|
+
"required": [
|
|
7172
|
+
"profileUuid",
|
|
7173
|
+
"tagUuid",
|
|
7174
|
+
"value"
|
|
7175
|
+
]
|
|
7176
|
+
},
|
|
7177
|
+
"security": [
|
|
7178
|
+
{
|
|
7179
|
+
"apiToken": []
|
|
7180
|
+
}
|
|
7181
|
+
],
|
|
7182
|
+
"group": "reach"
|
|
7183
|
+
},
|
|
7184
|
+
{
|
|
7185
|
+
"name": "reach_listProfileTagsV1",
|
|
7186
|
+
"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.",
|
|
7187
|
+
"method": "GET",
|
|
7188
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
7189
|
+
"inputSchema": {
|
|
7190
|
+
"type": "object",
|
|
7191
|
+
"properties": {
|
|
7192
|
+
"profileUuid": {
|
|
7193
|
+
"type": "string",
|
|
7194
|
+
"description": "Profile uuid parameter"
|
|
7195
|
+
}
|
|
7196
|
+
},
|
|
7197
|
+
"required": [
|
|
7198
|
+
"profileUuid"
|
|
7199
|
+
]
|
|
7200
|
+
},
|
|
7201
|
+
"security": [
|
|
7202
|
+
{
|
|
7203
|
+
"apiToken": []
|
|
7204
|
+
}
|
|
7205
|
+
],
|
|
7206
|
+
"group": "reach"
|
|
7207
|
+
},
|
|
7208
|
+
{
|
|
7209
|
+
"name": "reach_createOrFindTagsV1",
|
|
7210
|
+
"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.",
|
|
7211
|
+
"method": "POST",
|
|
7212
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
7213
|
+
"inputSchema": {
|
|
7214
|
+
"type": "object",
|
|
7215
|
+
"properties": {
|
|
7216
|
+
"profileUuid": {
|
|
7217
|
+
"type": "string",
|
|
7218
|
+
"description": "Profile uuid parameter"
|
|
7219
|
+
},
|
|
7220
|
+
"names": {
|
|
7221
|
+
"type": "array",
|
|
7222
|
+
"description": "names parameter",
|
|
7223
|
+
"items": {
|
|
7224
|
+
"type": "string",
|
|
7225
|
+
"description": "names parameter"
|
|
7226
|
+
}
|
|
7227
|
+
}
|
|
7228
|
+
},
|
|
7229
|
+
"required": [
|
|
7230
|
+
"profileUuid",
|
|
7231
|
+
"names"
|
|
7232
|
+
]
|
|
7233
|
+
},
|
|
7234
|
+
"security": [
|
|
7235
|
+
{
|
|
7236
|
+
"apiToken": []
|
|
7237
|
+
}
|
|
7238
|
+
],
|
|
7239
|
+
"group": "reach"
|
|
7240
|
+
},
|
|
6983
7241
|
{
|
|
6984
7242
|
"name": "reach_getProfileDomainDNSStatusV1",
|
|
6985
7243
|
"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.",
|