hostinger-api-mcp 1.31.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 +161 -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 +582 -4
- package/src/core/tools/all.ts +582 -4
- package/src/core/tools/reach.js +582 -4
- package/src/core/tools/reach.ts +582 -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 +343 -0
package/src/core/tools/all.ts
CHANGED
|
@@ -6768,7 +6768,7 @@ const tools: OpenApiTool[] = [
|
|
|
6768
6768
|
},
|
|
6769
6769
|
{
|
|
6770
6770
|
"name": "reach_listSegmentsV1",
|
|
6771
|
-
"description": "Get a list of all contact segments.\n\nThis endpoint returns a list of contact segments that can be used to organize contacts.",
|
|
6771
|
+
"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.",
|
|
6772
6772
|
"method": "GET",
|
|
6773
6773
|
"path": "/api/reach/v1/segmentation/segments",
|
|
6774
6774
|
"inputSchema": {
|
|
@@ -6785,7 +6785,7 @@ const tools: OpenApiTool[] = [
|
|
|
6785
6785
|
},
|
|
6786
6786
|
{
|
|
6787
6787
|
"name": "reach_createANewContactSegmentV1",
|
|
6788
|
-
"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.",
|
|
6788
|
+
"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.",
|
|
6789
6789
|
"method": "POST",
|
|
6790
6790
|
"path": "/api/reach/v1/segmentation/segments",
|
|
6791
6791
|
"inputSchema": {
|
|
@@ -6824,6 +6824,8 @@ const tools: OpenApiTool[] = [
|
|
|
6824
6824
|
"not_dropped",
|
|
6825
6825
|
"bounced",
|
|
6826
6826
|
"not_bounced",
|
|
6827
|
+
"soft_bounced",
|
|
6828
|
+
"not_soft_bounced",
|
|
6827
6829
|
"opened",
|
|
6828
6830
|
"not_opened",
|
|
6829
6831
|
"clicked",
|
|
@@ -6887,6 +6889,35 @@ const tools: OpenApiTool[] = [
|
|
|
6887
6889
|
],
|
|
6888
6890
|
"group": "reach"
|
|
6889
6891
|
},
|
|
6892
|
+
{
|
|
6893
|
+
"name": "reach_countProfileSegmentContactsV1",
|
|
6894
|
+
"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.",
|
|
6895
|
+
"method": "GET",
|
|
6896
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count",
|
|
6897
|
+
"inputSchema": {
|
|
6898
|
+
"type": "object",
|
|
6899
|
+
"properties": {
|
|
6900
|
+
"profileUuid": {
|
|
6901
|
+
"type": "string",
|
|
6902
|
+
"description": "Profile uuid parameter"
|
|
6903
|
+
},
|
|
6904
|
+
"segmentUuid": {
|
|
6905
|
+
"type": "string",
|
|
6906
|
+
"description": "Segment uuid parameter"
|
|
6907
|
+
}
|
|
6908
|
+
},
|
|
6909
|
+
"required": [
|
|
6910
|
+
"profileUuid",
|
|
6911
|
+
"segmentUuid"
|
|
6912
|
+
]
|
|
6913
|
+
},
|
|
6914
|
+
"security": [
|
|
6915
|
+
{
|
|
6916
|
+
"apiToken": []
|
|
6917
|
+
}
|
|
6918
|
+
],
|
|
6919
|
+
"group": "reach"
|
|
6920
|
+
},
|
|
6890
6921
|
{
|
|
6891
6922
|
"name": "reach_listProfileSegmentContactsV1",
|
|
6892
6923
|
"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.",
|
|
@@ -6924,9 +6955,298 @@ const tools: OpenApiTool[] = [
|
|
|
6924
6955
|
],
|
|
6925
6956
|
"group": "reach"
|
|
6926
6957
|
},
|
|
6958
|
+
{
|
|
6959
|
+
"name": "reach_getProfileSegmentDetailsV1",
|
|
6960
|
+
"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.",
|
|
6961
|
+
"method": "GET",
|
|
6962
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
6963
|
+
"inputSchema": {
|
|
6964
|
+
"type": "object",
|
|
6965
|
+
"properties": {
|
|
6966
|
+
"profileUuid": {
|
|
6967
|
+
"type": "string",
|
|
6968
|
+
"description": "Profile uuid parameter"
|
|
6969
|
+
},
|
|
6970
|
+
"segmentUuid": {
|
|
6971
|
+
"type": "string",
|
|
6972
|
+
"description": "Segment uuid parameter"
|
|
6973
|
+
}
|
|
6974
|
+
},
|
|
6975
|
+
"required": [
|
|
6976
|
+
"profileUuid",
|
|
6977
|
+
"segmentUuid"
|
|
6978
|
+
]
|
|
6979
|
+
},
|
|
6980
|
+
"security": [
|
|
6981
|
+
{
|
|
6982
|
+
"apiToken": []
|
|
6983
|
+
}
|
|
6984
|
+
],
|
|
6985
|
+
"group": "reach"
|
|
6986
|
+
},
|
|
6987
|
+
{
|
|
6988
|
+
"name": "reach_updateAProfileSegmentV1",
|
|
6989
|
+
"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.",
|
|
6990
|
+
"method": "PUT",
|
|
6991
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
6992
|
+
"inputSchema": {
|
|
6993
|
+
"type": "object",
|
|
6994
|
+
"properties": {
|
|
6995
|
+
"profileUuid": {
|
|
6996
|
+
"type": "string",
|
|
6997
|
+
"description": "Profile uuid parameter"
|
|
6998
|
+
},
|
|
6999
|
+
"segmentUuid": {
|
|
7000
|
+
"type": "string",
|
|
7001
|
+
"description": "Segment uuid parameter"
|
|
7002
|
+
},
|
|
7003
|
+
"name": {
|
|
7004
|
+
"type": "string",
|
|
7005
|
+
"description": "name parameter"
|
|
7006
|
+
},
|
|
7007
|
+
"conditions": {
|
|
7008
|
+
"type": "array",
|
|
7009
|
+
"description": "Replaces the existing conditions entirely. Omit to keep the current ones.",
|
|
7010
|
+
"items": {
|
|
7011
|
+
"type": "object",
|
|
7012
|
+
"description": "conditions parameter",
|
|
7013
|
+
"properties": {
|
|
7014
|
+
"attribute": {
|
|
7015
|
+
"type": "string",
|
|
7016
|
+
"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."
|
|
7017
|
+
},
|
|
7018
|
+
"operator": {
|
|
7019
|
+
"type": "string",
|
|
7020
|
+
"description": "operator parameter",
|
|
7021
|
+
"enum": [
|
|
7022
|
+
"equals",
|
|
7023
|
+
"not_equals",
|
|
7024
|
+
"contains",
|
|
7025
|
+
"not_contains",
|
|
7026
|
+
"gte",
|
|
7027
|
+
"lte",
|
|
7028
|
+
"exists",
|
|
7029
|
+
"within_last_days",
|
|
7030
|
+
"not_within_last_days",
|
|
7031
|
+
"older_than_days",
|
|
7032
|
+
"processed",
|
|
7033
|
+
"not_processed",
|
|
7034
|
+
"delivered",
|
|
7035
|
+
"not_delivered",
|
|
7036
|
+
"dropped",
|
|
7037
|
+
"not_dropped",
|
|
7038
|
+
"bounced",
|
|
7039
|
+
"not_bounced",
|
|
7040
|
+
"soft_bounced",
|
|
7041
|
+
"not_soft_bounced",
|
|
7042
|
+
"opened",
|
|
7043
|
+
"not_opened",
|
|
7044
|
+
"clicked",
|
|
7045
|
+
"not_clicked",
|
|
7046
|
+
"unsubscribed",
|
|
7047
|
+
"not_unsubscribed"
|
|
7048
|
+
]
|
|
7049
|
+
},
|
|
7050
|
+
"value": {
|
|
7051
|
+
"type": "string",
|
|
7052
|
+
"description": "Always a string, including for numeric and date comparisons"
|
|
7053
|
+
}
|
|
7054
|
+
},
|
|
7055
|
+
"required": [
|
|
7056
|
+
"attribute",
|
|
7057
|
+
"operator",
|
|
7058
|
+
"value"
|
|
7059
|
+
]
|
|
7060
|
+
}
|
|
7061
|
+
},
|
|
7062
|
+
"logic": {
|
|
7063
|
+
"type": "string",
|
|
7064
|
+
"description": "How to combine multiple conditions. Required when conditions are given.",
|
|
7065
|
+
"enum": [
|
|
7066
|
+
"AND",
|
|
7067
|
+
"OR"
|
|
7068
|
+
]
|
|
7069
|
+
}
|
|
7070
|
+
},
|
|
7071
|
+
"required": [
|
|
7072
|
+
"profileUuid",
|
|
7073
|
+
"segmentUuid",
|
|
7074
|
+
"name"
|
|
7075
|
+
]
|
|
7076
|
+
},
|
|
7077
|
+
"security": [
|
|
7078
|
+
{
|
|
7079
|
+
"apiToken": []
|
|
7080
|
+
}
|
|
7081
|
+
],
|
|
7082
|
+
"group": "reach"
|
|
7083
|
+
},
|
|
7084
|
+
{
|
|
7085
|
+
"name": "reach_deleteAProfileSegmentV1",
|
|
7086
|
+
"description": "Delete a segment.\n\nOnly the segment definition is removed. The contacts that matched it are left untouched.",
|
|
7087
|
+
"method": "DELETE",
|
|
7088
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}",
|
|
7089
|
+
"inputSchema": {
|
|
7090
|
+
"type": "object",
|
|
7091
|
+
"properties": {
|
|
7092
|
+
"profileUuid": {
|
|
7093
|
+
"type": "string",
|
|
7094
|
+
"description": "Profile uuid parameter"
|
|
7095
|
+
},
|
|
7096
|
+
"segmentUuid": {
|
|
7097
|
+
"type": "string",
|
|
7098
|
+
"description": "Segment uuid parameter"
|
|
7099
|
+
}
|
|
7100
|
+
},
|
|
7101
|
+
"required": [
|
|
7102
|
+
"profileUuid",
|
|
7103
|
+
"segmentUuid"
|
|
7104
|
+
]
|
|
7105
|
+
},
|
|
7106
|
+
"security": [
|
|
7107
|
+
{
|
|
7108
|
+
"apiToken": []
|
|
7109
|
+
}
|
|
7110
|
+
],
|
|
7111
|
+
"group": "reach"
|
|
7112
|
+
},
|
|
7113
|
+
{
|
|
7114
|
+
"name": "reach_listProfileSegmentsV1",
|
|
7115
|
+
"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.",
|
|
7116
|
+
"method": "GET",
|
|
7117
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments",
|
|
7118
|
+
"inputSchema": {
|
|
7119
|
+
"type": "object",
|
|
7120
|
+
"properties": {
|
|
7121
|
+
"profileUuid": {
|
|
7122
|
+
"type": "string",
|
|
7123
|
+
"description": "Profile uuid parameter"
|
|
7124
|
+
},
|
|
7125
|
+
"count_type": {
|
|
7126
|
+
"type": "string",
|
|
7127
|
+
"description": "Which matching contacts to count for each segment",
|
|
7128
|
+
"enum": [
|
|
7129
|
+
"all",
|
|
7130
|
+
"subscribed"
|
|
7131
|
+
]
|
|
7132
|
+
},
|
|
7133
|
+
"page": {
|
|
7134
|
+
"type": "integer",
|
|
7135
|
+
"description": "Page number"
|
|
7136
|
+
},
|
|
7137
|
+
"per_page": {
|
|
7138
|
+
"type": "integer",
|
|
7139
|
+
"description": "Number of items per page"
|
|
7140
|
+
}
|
|
7141
|
+
},
|
|
7142
|
+
"required": [
|
|
7143
|
+
"profileUuid"
|
|
7144
|
+
]
|
|
7145
|
+
},
|
|
7146
|
+
"security": [
|
|
7147
|
+
{
|
|
7148
|
+
"apiToken": []
|
|
7149
|
+
}
|
|
7150
|
+
],
|
|
7151
|
+
"group": "reach"
|
|
7152
|
+
},
|
|
7153
|
+
{
|
|
7154
|
+
"name": "reach_createAProfileSegmentV1",
|
|
7155
|
+
"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.",
|
|
7156
|
+
"method": "POST",
|
|
7157
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/segmentation/segments",
|
|
7158
|
+
"inputSchema": {
|
|
7159
|
+
"type": "object",
|
|
7160
|
+
"properties": {
|
|
7161
|
+
"profileUuid": {
|
|
7162
|
+
"type": "string",
|
|
7163
|
+
"description": "Profile uuid parameter"
|
|
7164
|
+
},
|
|
7165
|
+
"name": {
|
|
7166
|
+
"type": "string",
|
|
7167
|
+
"description": "name parameter"
|
|
7168
|
+
},
|
|
7169
|
+
"conditions": {
|
|
7170
|
+
"type": "array",
|
|
7171
|
+
"description": "Conditions a contact must satisfy to fall into the segment",
|
|
7172
|
+
"items": {
|
|
7173
|
+
"type": "object",
|
|
7174
|
+
"description": "conditions parameter",
|
|
7175
|
+
"properties": {
|
|
7176
|
+
"attribute": {
|
|
7177
|
+
"type": "string",
|
|
7178
|
+
"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."
|
|
7179
|
+
},
|
|
7180
|
+
"operator": {
|
|
7181
|
+
"type": "string",
|
|
7182
|
+
"description": "operator parameter",
|
|
7183
|
+
"enum": [
|
|
7184
|
+
"equals",
|
|
7185
|
+
"not_equals",
|
|
7186
|
+
"contains",
|
|
7187
|
+
"not_contains",
|
|
7188
|
+
"gte",
|
|
7189
|
+
"lte",
|
|
7190
|
+
"exists",
|
|
7191
|
+
"within_last_days",
|
|
7192
|
+
"not_within_last_days",
|
|
7193
|
+
"older_than_days",
|
|
7194
|
+
"processed",
|
|
7195
|
+
"not_processed",
|
|
7196
|
+
"delivered",
|
|
7197
|
+
"not_delivered",
|
|
7198
|
+
"dropped",
|
|
7199
|
+
"not_dropped",
|
|
7200
|
+
"bounced",
|
|
7201
|
+
"not_bounced",
|
|
7202
|
+
"soft_bounced",
|
|
7203
|
+
"not_soft_bounced",
|
|
7204
|
+
"opened",
|
|
7205
|
+
"not_opened",
|
|
7206
|
+
"clicked",
|
|
7207
|
+
"not_clicked",
|
|
7208
|
+
"unsubscribed",
|
|
7209
|
+
"not_unsubscribed"
|
|
7210
|
+
]
|
|
7211
|
+
},
|
|
7212
|
+
"value": {
|
|
7213
|
+
"type": "string",
|
|
7214
|
+
"description": "Always a string, including for numeric and date comparisons"
|
|
7215
|
+
}
|
|
7216
|
+
},
|
|
7217
|
+
"required": [
|
|
7218
|
+
"attribute",
|
|
7219
|
+
"operator",
|
|
7220
|
+
"value"
|
|
7221
|
+
]
|
|
7222
|
+
}
|
|
7223
|
+
},
|
|
7224
|
+
"logic": {
|
|
7225
|
+
"type": "string",
|
|
7226
|
+
"description": "How to combine multiple conditions",
|
|
7227
|
+
"enum": [
|
|
7228
|
+
"AND",
|
|
7229
|
+
"OR"
|
|
7230
|
+
]
|
|
7231
|
+
}
|
|
7232
|
+
},
|
|
7233
|
+
"required": [
|
|
7234
|
+
"profileUuid",
|
|
7235
|
+
"name",
|
|
7236
|
+
"conditions",
|
|
7237
|
+
"logic"
|
|
7238
|
+
]
|
|
7239
|
+
},
|
|
7240
|
+
"security": [
|
|
7241
|
+
{
|
|
7242
|
+
"apiToken": []
|
|
7243
|
+
}
|
|
7244
|
+
],
|
|
7245
|
+
"group": "reach"
|
|
7246
|
+
},
|
|
6927
7247
|
{
|
|
6928
7248
|
"name": "reach_listSegmentContactsV1",
|
|
6929
|
-
"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.",
|
|
7249
|
+
"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.",
|
|
6930
7250
|
"method": "GET",
|
|
6931
7251
|
"path": "/api/reach/v1/segmentation/segments/{segmentUuid}/contacts",
|
|
6932
7252
|
"inputSchema": {
|
|
@@ -6958,7 +7278,7 @@ const tools: OpenApiTool[] = [
|
|
|
6958
7278
|
},
|
|
6959
7279
|
{
|
|
6960
7280
|
"name": "reach_getSegmentDetailsV1",
|
|
6961
|
-
"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.",
|
|
7281
|
+
"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.",
|
|
6962
7282
|
"method": "GET",
|
|
6963
7283
|
"path": "/api/reach/v1/segmentation/segments/{segmentUuid}",
|
|
6964
7284
|
"inputSchema": {
|
|
@@ -6980,6 +7300,264 @@ const tools: OpenApiTool[] = [
|
|
|
6980
7300
|
],
|
|
6981
7301
|
"group": "reach"
|
|
6982
7302
|
},
|
|
7303
|
+
{
|
|
7304
|
+
"name": "reach_assignAContactToATagV1",
|
|
7305
|
+
"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.",
|
|
7306
|
+
"method": "POST",
|
|
7307
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
7308
|
+
"inputSchema": {
|
|
7309
|
+
"type": "object",
|
|
7310
|
+
"properties": {
|
|
7311
|
+
"profileUuid": {
|
|
7312
|
+
"type": "string",
|
|
7313
|
+
"description": "Profile uuid parameter"
|
|
7314
|
+
},
|
|
7315
|
+
"tagUuid": {
|
|
7316
|
+
"type": "string",
|
|
7317
|
+
"description": "Tag uuid parameter"
|
|
7318
|
+
},
|
|
7319
|
+
"contactUuid": {
|
|
7320
|
+
"type": "string",
|
|
7321
|
+
"description": "Contact uuid parameter"
|
|
7322
|
+
}
|
|
7323
|
+
},
|
|
7324
|
+
"required": [
|
|
7325
|
+
"profileUuid",
|
|
7326
|
+
"tagUuid",
|
|
7327
|
+
"contactUuid"
|
|
7328
|
+
]
|
|
7329
|
+
},
|
|
7330
|
+
"security": [
|
|
7331
|
+
{
|
|
7332
|
+
"apiToken": []
|
|
7333
|
+
}
|
|
7334
|
+
],
|
|
7335
|
+
"group": "reach"
|
|
7336
|
+
},
|
|
7337
|
+
{
|
|
7338
|
+
"name": "reach_removeAContactFromATagV1",
|
|
7339
|
+
"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.",
|
|
7340
|
+
"method": "DELETE",
|
|
7341
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}",
|
|
7342
|
+
"inputSchema": {
|
|
7343
|
+
"type": "object",
|
|
7344
|
+
"properties": {
|
|
7345
|
+
"profileUuid": {
|
|
7346
|
+
"type": "string",
|
|
7347
|
+
"description": "Profile uuid parameter"
|
|
7348
|
+
},
|
|
7349
|
+
"tagUuid": {
|
|
7350
|
+
"type": "string",
|
|
7351
|
+
"description": "Tag uuid parameter"
|
|
7352
|
+
},
|
|
7353
|
+
"contactUuid": {
|
|
7354
|
+
"type": "string",
|
|
7355
|
+
"description": "Contact uuid parameter"
|
|
7356
|
+
}
|
|
7357
|
+
},
|
|
7358
|
+
"required": [
|
|
7359
|
+
"profileUuid",
|
|
7360
|
+
"tagUuid",
|
|
7361
|
+
"contactUuid"
|
|
7362
|
+
]
|
|
7363
|
+
},
|
|
7364
|
+
"security": [
|
|
7365
|
+
{
|
|
7366
|
+
"apiToken": []
|
|
7367
|
+
}
|
|
7368
|
+
],
|
|
7369
|
+
"group": "reach"
|
|
7370
|
+
},
|
|
7371
|
+
{
|
|
7372
|
+
"name": "reach_assignContactsToATagV1",
|
|
7373
|
+
"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.",
|
|
7374
|
+
"method": "POST",
|
|
7375
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
7376
|
+
"inputSchema": {
|
|
7377
|
+
"type": "object",
|
|
7378
|
+
"properties": {
|
|
7379
|
+
"profileUuid": {
|
|
7380
|
+
"type": "string",
|
|
7381
|
+
"description": "Profile uuid parameter"
|
|
7382
|
+
},
|
|
7383
|
+
"tagUuid": {
|
|
7384
|
+
"type": "string",
|
|
7385
|
+
"description": "Tag uuid parameter"
|
|
7386
|
+
},
|
|
7387
|
+
"contact_uuids": {
|
|
7388
|
+
"type": "array",
|
|
7389
|
+
"description": "Contacts to apply the change to. Required unless all_contacts is true.",
|
|
7390
|
+
"items": {
|
|
7391
|
+
"type": "string",
|
|
7392
|
+
"description": "contact_uuids parameter"
|
|
7393
|
+
}
|
|
7394
|
+
},
|
|
7395
|
+
"all_contacts": {
|
|
7396
|
+
"type": "boolean",
|
|
7397
|
+
"description": "Apply to every contact in the profile"
|
|
7398
|
+
}
|
|
7399
|
+
},
|
|
7400
|
+
"required": [
|
|
7401
|
+
"profileUuid",
|
|
7402
|
+
"tagUuid"
|
|
7403
|
+
]
|
|
7404
|
+
},
|
|
7405
|
+
"security": [
|
|
7406
|
+
{
|
|
7407
|
+
"apiToken": []
|
|
7408
|
+
}
|
|
7409
|
+
],
|
|
7410
|
+
"group": "reach"
|
|
7411
|
+
},
|
|
7412
|
+
{
|
|
7413
|
+
"name": "reach_removeContactsFromATagV1",
|
|
7414
|
+
"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.",
|
|
7415
|
+
"method": "DELETE",
|
|
7416
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts",
|
|
7417
|
+
"inputSchema": {
|
|
7418
|
+
"type": "object",
|
|
7419
|
+
"properties": {
|
|
7420
|
+
"profileUuid": {
|
|
7421
|
+
"type": "string",
|
|
7422
|
+
"description": "Profile uuid parameter"
|
|
7423
|
+
},
|
|
7424
|
+
"tagUuid": {
|
|
7425
|
+
"type": "string",
|
|
7426
|
+
"description": "Tag uuid parameter"
|
|
7427
|
+
}
|
|
7428
|
+
},
|
|
7429
|
+
"required": [
|
|
7430
|
+
"profileUuid",
|
|
7431
|
+
"tagUuid"
|
|
7432
|
+
]
|
|
7433
|
+
},
|
|
7434
|
+
"security": [
|
|
7435
|
+
{
|
|
7436
|
+
"apiToken": []
|
|
7437
|
+
}
|
|
7438
|
+
],
|
|
7439
|
+
"group": "reach"
|
|
7440
|
+
},
|
|
7441
|
+
{
|
|
7442
|
+
"name": "reach_deleteATagV1",
|
|
7443
|
+
"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.",
|
|
7444
|
+
"method": "DELETE",
|
|
7445
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
7446
|
+
"inputSchema": {
|
|
7447
|
+
"type": "object",
|
|
7448
|
+
"properties": {
|
|
7449
|
+
"profileUuid": {
|
|
7450
|
+
"type": "string",
|
|
7451
|
+
"description": "Profile uuid parameter"
|
|
7452
|
+
},
|
|
7453
|
+
"tagUuid": {
|
|
7454
|
+
"type": "string",
|
|
7455
|
+
"description": "Tag uuid parameter"
|
|
7456
|
+
}
|
|
7457
|
+
},
|
|
7458
|
+
"required": [
|
|
7459
|
+
"profileUuid",
|
|
7460
|
+
"tagUuid"
|
|
7461
|
+
]
|
|
7462
|
+
},
|
|
7463
|
+
"security": [
|
|
7464
|
+
{
|
|
7465
|
+
"apiToken": []
|
|
7466
|
+
}
|
|
7467
|
+
],
|
|
7468
|
+
"group": "reach"
|
|
7469
|
+
},
|
|
7470
|
+
{
|
|
7471
|
+
"name": "reach_renameATagV1",
|
|
7472
|
+
"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.",
|
|
7473
|
+
"method": "PATCH",
|
|
7474
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}",
|
|
7475
|
+
"inputSchema": {
|
|
7476
|
+
"type": "object",
|
|
7477
|
+
"properties": {
|
|
7478
|
+
"profileUuid": {
|
|
7479
|
+
"type": "string",
|
|
7480
|
+
"description": "Profile uuid parameter"
|
|
7481
|
+
},
|
|
7482
|
+
"tagUuid": {
|
|
7483
|
+
"type": "string",
|
|
7484
|
+
"description": "Tag uuid parameter"
|
|
7485
|
+
},
|
|
7486
|
+
"value": {
|
|
7487
|
+
"type": "string",
|
|
7488
|
+
"description": "New tag name"
|
|
7489
|
+
}
|
|
7490
|
+
},
|
|
7491
|
+
"required": [
|
|
7492
|
+
"profileUuid",
|
|
7493
|
+
"tagUuid",
|
|
7494
|
+
"value"
|
|
7495
|
+
]
|
|
7496
|
+
},
|
|
7497
|
+
"security": [
|
|
7498
|
+
{
|
|
7499
|
+
"apiToken": []
|
|
7500
|
+
}
|
|
7501
|
+
],
|
|
7502
|
+
"group": "reach"
|
|
7503
|
+
},
|
|
7504
|
+
{
|
|
7505
|
+
"name": "reach_listProfileTagsV1",
|
|
7506
|
+
"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.",
|
|
7507
|
+
"method": "GET",
|
|
7508
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
7509
|
+
"inputSchema": {
|
|
7510
|
+
"type": "object",
|
|
7511
|
+
"properties": {
|
|
7512
|
+
"profileUuid": {
|
|
7513
|
+
"type": "string",
|
|
7514
|
+
"description": "Profile uuid parameter"
|
|
7515
|
+
}
|
|
7516
|
+
},
|
|
7517
|
+
"required": [
|
|
7518
|
+
"profileUuid"
|
|
7519
|
+
]
|
|
7520
|
+
},
|
|
7521
|
+
"security": [
|
|
7522
|
+
{
|
|
7523
|
+
"apiToken": []
|
|
7524
|
+
}
|
|
7525
|
+
],
|
|
7526
|
+
"group": "reach"
|
|
7527
|
+
},
|
|
7528
|
+
{
|
|
7529
|
+
"name": "reach_createOrFindTagsV1",
|
|
7530
|
+
"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.",
|
|
7531
|
+
"method": "POST",
|
|
7532
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/tags",
|
|
7533
|
+
"inputSchema": {
|
|
7534
|
+
"type": "object",
|
|
7535
|
+
"properties": {
|
|
7536
|
+
"profileUuid": {
|
|
7537
|
+
"type": "string",
|
|
7538
|
+
"description": "Profile uuid parameter"
|
|
7539
|
+
},
|
|
7540
|
+
"names": {
|
|
7541
|
+
"type": "array",
|
|
7542
|
+
"description": "names parameter",
|
|
7543
|
+
"items": {
|
|
7544
|
+
"type": "string",
|
|
7545
|
+
"description": "names parameter"
|
|
7546
|
+
}
|
|
7547
|
+
}
|
|
7548
|
+
},
|
|
7549
|
+
"required": [
|
|
7550
|
+
"profileUuid",
|
|
7551
|
+
"names"
|
|
7552
|
+
]
|
|
7553
|
+
},
|
|
7554
|
+
"security": [
|
|
7555
|
+
{
|
|
7556
|
+
"apiToken": []
|
|
7557
|
+
}
|
|
7558
|
+
],
|
|
7559
|
+
"group": "reach"
|
|
7560
|
+
},
|
|
6983
7561
|
{
|
|
6984
7562
|
"name": "reach_getProfileDomainDNSStatusV1",
|
|
6985
7563
|
"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.",
|