hostinger-api-mcp 2.12.0 → 2.13.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/CHANGELOG.md +15 -0
- package/README.md +71 -12
- 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 +242 -10
- package/src/core/tools/all.ts +242 -10
- package/src/core/tools/reach.js +242 -10
- package/src/core/tools/reach.ts +242 -10
- 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 +187 -11
package/src/core/tools/all.ts
CHANGED
|
@@ -12841,16 +12841,16 @@ const tools: OpenApiTool[] = [
|
|
|
12841
12841
|
"group": "reach"
|
|
12842
12842
|
},
|
|
12843
12843
|
{
|
|
12844
|
-
"name": "
|
|
12845
|
-
"title": "Get
|
|
12844
|
+
"name": "reach_profiles_connected-sending-domain",
|
|
12845
|
+
"title": "Get connected sending domain",
|
|
12846
12846
|
"annotations": {
|
|
12847
|
-
"title": "Get
|
|
12847
|
+
"title": "Get connected sending domain",
|
|
12848
12848
|
"readOnlyHint": true,
|
|
12849
12849
|
"destructiveHint": false
|
|
12850
12850
|
},
|
|
12851
|
-
"description": "
|
|
12851
|
+
"description": "Get the sending domain connected to the profile, its verification status and any suspended\nsender addresses.\n\nCampaigns only go out once a domain is connected and active, so this is the cheapest way to\ncheck that precondition before building one. A profile with no domain connected returns the\nsame shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records\nbehind the status, use the DNS status endpoint.",
|
|
12852
12852
|
"method": "GET",
|
|
12853
|
-
"path": "/api/reach/v1/profiles/{profileUuid}/domains
|
|
12853
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
12854
12854
|
"inputSchema": {
|
|
12855
12855
|
"type": "object",
|
|
12856
12856
|
"properties": {
|
|
@@ -12871,16 +12871,82 @@ const tools: OpenApiTool[] = [
|
|
|
12871
12871
|
"group": "reach"
|
|
12872
12872
|
},
|
|
12873
12873
|
{
|
|
12874
|
-
"name": "
|
|
12875
|
-
"title": "
|
|
12874
|
+
"name": "reach_profiles_connect-sending-domain",
|
|
12875
|
+
"title": "Connect sending domain",
|
|
12876
12876
|
"annotations": {
|
|
12877
|
-
"title": "
|
|
12877
|
+
"title": "Connect sending domain",
|
|
12878
|
+
"readOnlyHint": false,
|
|
12879
|
+
"destructiveHint": false
|
|
12880
|
+
},
|
|
12881
|
+
"description": "Connect a sending domain to the profile so emails can be sent from addresses on it.\n\nConnecting does not make the domain ready to send: check the DNS status endpoint next for\nrecords that are still missing. A domain the account owns or has already verified connects\nimmediately. Any other domain starts a TXT ownership verification and returns `409`;\ncomplete the verification in Reach, then retry. Returns `422` when the profile or another\nprofile already has the domain, the domain is blocked, or its ownership cannot be verified.\nAn already connected domain is never replaced.\n\nOn success the sender address of draft and scheduled campaigns, and of published automation\nand double opt-in emails, moves onto the new domain in the background, keeping the part\nbefore the `@`.",
|
|
12882
|
+
"method": "POST",
|
|
12883
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
12884
|
+
"inputSchema": {
|
|
12885
|
+
"type": "object",
|
|
12886
|
+
"properties": {
|
|
12887
|
+
"profileUuid": {
|
|
12888
|
+
"type": "string",
|
|
12889
|
+
"description": "Profile uuid parameter"
|
|
12890
|
+
},
|
|
12891
|
+
"domain": {
|
|
12892
|
+
"type": "string",
|
|
12893
|
+
"description": "domain parameter"
|
|
12894
|
+
}
|
|
12895
|
+
},
|
|
12896
|
+
"required": [
|
|
12897
|
+
"profileUuid",
|
|
12898
|
+
"domain"
|
|
12899
|
+
]
|
|
12900
|
+
},
|
|
12901
|
+
"security": [
|
|
12902
|
+
{
|
|
12903
|
+
"apiToken": []
|
|
12904
|
+
}
|
|
12905
|
+
],
|
|
12906
|
+
"group": "reach"
|
|
12907
|
+
},
|
|
12908
|
+
{
|
|
12909
|
+
"name": "reach_profiles_delete-sending-domain",
|
|
12910
|
+
"title": "Delete sending domain",
|
|
12911
|
+
"annotations": {
|
|
12912
|
+
"title": "Delete sending domain",
|
|
12913
|
+
"readOnlyHint": false,
|
|
12914
|
+
"destructiveHint": true,
|
|
12915
|
+
"idempotentHint": true
|
|
12916
|
+
},
|
|
12917
|
+
"description": "Disconnect the sending domain from the profile.\n\nThe domain record is removed, so the profile has no sending domain afterwards and campaigns\ncannot be sent until a domain is connected again. Sender addresses already stored on\ncampaigns, automations and settings are left untouched and keep pointing at the removed\ndomain. A domain that is not connected to the profile also succeeds, so success is not proof\nthat anything was deleted. DNS records at the DNS provider are not removed. To switch\ndomains, delete this one and connect the new one. Confirm the domain with the customer\nbefore calling.",
|
|
12918
|
+
"method": "DELETE",
|
|
12919
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
12920
|
+
"inputSchema": {
|
|
12921
|
+
"type": "object",
|
|
12922
|
+
"properties": {
|
|
12923
|
+
"profileUuid": {
|
|
12924
|
+
"type": "string",
|
|
12925
|
+
"description": "Profile uuid parameter"
|
|
12926
|
+
}
|
|
12927
|
+
},
|
|
12928
|
+
"required": [
|
|
12929
|
+
"profileUuid"
|
|
12930
|
+
]
|
|
12931
|
+
},
|
|
12932
|
+
"security": [
|
|
12933
|
+
{
|
|
12934
|
+
"apiToken": []
|
|
12935
|
+
}
|
|
12936
|
+
],
|
|
12937
|
+
"group": "reach"
|
|
12938
|
+
},
|
|
12939
|
+
{
|
|
12940
|
+
"name": "reach_profiles_domain-dns-status",
|
|
12941
|
+
"title": "Get profile domain DNS status",
|
|
12942
|
+
"annotations": {
|
|
12943
|
+
"title": "Get profile domain DNS status",
|
|
12878
12944
|
"readOnlyHint": true,
|
|
12879
12945
|
"destructiveHint": false
|
|
12880
12946
|
},
|
|
12881
|
-
"description": "
|
|
12947
|
+
"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.",
|
|
12882
12948
|
"method": "GET",
|
|
12883
|
-
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
12949
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/domains/dns-status",
|
|
12884
12950
|
"inputSchema": {
|
|
12885
12951
|
"type": "object",
|
|
12886
12952
|
"properties": {
|
|
@@ -12983,6 +13049,172 @@ const tools: OpenApiTool[] = [
|
|
|
12983
13049
|
],
|
|
12984
13050
|
"group": "reach"
|
|
12985
13051
|
},
|
|
13052
|
+
{
|
|
13053
|
+
"name": "reach_profiles_settings",
|
|
13054
|
+
"title": "Get profile settings",
|
|
13055
|
+
"annotations": {
|
|
13056
|
+
"title": "Get profile settings",
|
|
13057
|
+
"readOnlyHint": true,
|
|
13058
|
+
"destructiveHint": false
|
|
13059
|
+
},
|
|
13060
|
+
"description": "Get the profile's saved sender identity and brand details.\n\nRead the default sender before creating a campaign instead of asking the customer, and\nreuse the brand fields when generating email content. Any field can be `null` for a profile\nthat never filled its settings in. This does not check that the sending domain is\nverified, use the connected sending domain endpoint for that.",
|
|
13061
|
+
"method": "GET",
|
|
13062
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/settings",
|
|
13063
|
+
"inputSchema": {
|
|
13064
|
+
"type": "object",
|
|
13065
|
+
"properties": {
|
|
13066
|
+
"profileUuid": {
|
|
13067
|
+
"type": "string",
|
|
13068
|
+
"description": "Profile uuid parameter"
|
|
13069
|
+
}
|
|
13070
|
+
},
|
|
13071
|
+
"required": [
|
|
13072
|
+
"profileUuid"
|
|
13073
|
+
]
|
|
13074
|
+
},
|
|
13075
|
+
"security": [
|
|
13076
|
+
{
|
|
13077
|
+
"apiToken": []
|
|
13078
|
+
}
|
|
13079
|
+
],
|
|
13080
|
+
"group": "reach"
|
|
13081
|
+
},
|
|
13082
|
+
{
|
|
13083
|
+
"name": "reach_profiles_update-settings",
|
|
13084
|
+
"title": "Update profile settings",
|
|
13085
|
+
"annotations": {
|
|
13086
|
+
"title": "Update profile settings",
|
|
13087
|
+
"readOnlyHint": false,
|
|
13088
|
+
"destructiveHint": true,
|
|
13089
|
+
"idempotentHint": true
|
|
13090
|
+
},
|
|
13091
|
+
"description": "Change the profile's default sender and brand details.\n\nSend only the fields to change: every omitted field keeps its value, and `null` or an empty\nstring clears a text field. The default sender is what campaigns created afterwards start\nfrom; existing campaigns keep their own sender. `sender_email` is only the part before the\n`@`, because Reach combines it with the profile's connected sending domain, so an address\noutside that domain cannot be set. Connecting a sending domain is a separate endpoint and\na connected domain cannot be changed here. Returns the settings after the change.",
|
|
13092
|
+
"method": "PATCH",
|
|
13093
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/settings",
|
|
13094
|
+
"inputSchema": {
|
|
13095
|
+
"type": "object",
|
|
13096
|
+
"properties": {
|
|
13097
|
+
"profileUuid": {
|
|
13098
|
+
"type": "string",
|
|
13099
|
+
"description": "Profile uuid parameter"
|
|
13100
|
+
},
|
|
13101
|
+
"brand_name": {
|
|
13102
|
+
"type": "string",
|
|
13103
|
+
"description": "brand_name parameter"
|
|
13104
|
+
},
|
|
13105
|
+
"website_url": {
|
|
13106
|
+
"type": "string",
|
|
13107
|
+
"description": "website_url parameter"
|
|
13108
|
+
},
|
|
13109
|
+
"business_address": {
|
|
13110
|
+
"type": "string",
|
|
13111
|
+
"description": "business_address parameter"
|
|
13112
|
+
},
|
|
13113
|
+
"privacy_policy_url": {
|
|
13114
|
+
"type": "string",
|
|
13115
|
+
"description": "privacy_policy_url parameter"
|
|
13116
|
+
},
|
|
13117
|
+
"accent_color": {
|
|
13118
|
+
"type": "string",
|
|
13119
|
+
"description": "accent_color parameter"
|
|
13120
|
+
},
|
|
13121
|
+
"button_color": {
|
|
13122
|
+
"type": "string",
|
|
13123
|
+
"description": "button_color parameter"
|
|
13124
|
+
},
|
|
13125
|
+
"background_color": {
|
|
13126
|
+
"type": "string",
|
|
13127
|
+
"description": "background_color parameter"
|
|
13128
|
+
},
|
|
13129
|
+
"text_color": {
|
|
13130
|
+
"type": "string",
|
|
13131
|
+
"description": "text_color parameter"
|
|
13132
|
+
},
|
|
13133
|
+
"links_color": {
|
|
13134
|
+
"type": "string",
|
|
13135
|
+
"description": "links_color parameter"
|
|
13136
|
+
},
|
|
13137
|
+
"button_text": {
|
|
13138
|
+
"type": "string",
|
|
13139
|
+
"description": "Button text colour."
|
|
13140
|
+
},
|
|
13141
|
+
"button_corners": {
|
|
13142
|
+
"type": "integer",
|
|
13143
|
+
"description": "button_corners parameter"
|
|
13144
|
+
},
|
|
13145
|
+
"font_family": {
|
|
13146
|
+
"type": "string",
|
|
13147
|
+
"description": "font_family parameter"
|
|
13148
|
+
},
|
|
13149
|
+
"heading_font_family": {
|
|
13150
|
+
"type": "string",
|
|
13151
|
+
"description": "heading_font_family parameter"
|
|
13152
|
+
},
|
|
13153
|
+
"logo_url": {
|
|
13154
|
+
"type": "string",
|
|
13155
|
+
"description": "Public image URL. Logo uploads are not supported."
|
|
13156
|
+
},
|
|
13157
|
+
"social_links": {
|
|
13158
|
+
"type": "array",
|
|
13159
|
+
"description": "social_links parameter",
|
|
13160
|
+
"items": {
|
|
13161
|
+
"type": "string",
|
|
13162
|
+
"description": "social_links parameter"
|
|
13163
|
+
}
|
|
13164
|
+
},
|
|
13165
|
+
"socials": {
|
|
13166
|
+
"type": "object",
|
|
13167
|
+
"description": "Social profile links keyed by platform.",
|
|
13168
|
+
"properties": {}
|
|
13169
|
+
},
|
|
13170
|
+
"about": {
|
|
13171
|
+
"type": "string",
|
|
13172
|
+
"description": "about parameter"
|
|
13173
|
+
},
|
|
13174
|
+
"keywords": {
|
|
13175
|
+
"type": "array",
|
|
13176
|
+
"description": "keywords parameter",
|
|
13177
|
+
"items": {
|
|
13178
|
+
"type": "string",
|
|
13179
|
+
"description": "keywords parameter"
|
|
13180
|
+
}
|
|
13181
|
+
},
|
|
13182
|
+
"topics": {
|
|
13183
|
+
"type": "array",
|
|
13184
|
+
"description": "topics parameter",
|
|
13185
|
+
"items": {
|
|
13186
|
+
"type": "string",
|
|
13187
|
+
"description": "topics parameter"
|
|
13188
|
+
}
|
|
13189
|
+
},
|
|
13190
|
+
"selling_points": {
|
|
13191
|
+
"type": "array",
|
|
13192
|
+
"description": "selling_points parameter",
|
|
13193
|
+
"items": {
|
|
13194
|
+
"type": "string",
|
|
13195
|
+
"description": "selling_points parameter"
|
|
13196
|
+
}
|
|
13197
|
+
},
|
|
13198
|
+
"sender_name": {
|
|
13199
|
+
"type": "string",
|
|
13200
|
+
"description": "Default sender name. Letters, numbers and spaces only."
|
|
13201
|
+
},
|
|
13202
|
+
"sender_email": {
|
|
13203
|
+
"type": "string",
|
|
13204
|
+
"description": "Part of the default sender address before the `@`, for example `hello`. Never send a\nfull address: Reach adds the profile's connected sending domain itself."
|
|
13205
|
+
}
|
|
13206
|
+
},
|
|
13207
|
+
"required": [
|
|
13208
|
+
"profileUuid"
|
|
13209
|
+
]
|
|
13210
|
+
},
|
|
13211
|
+
"security": [
|
|
13212
|
+
{
|
|
13213
|
+
"apiToken": []
|
|
13214
|
+
}
|
|
13215
|
+
],
|
|
13216
|
+
"group": "reach"
|
|
13217
|
+
},
|
|
12986
13218
|
{
|
|
12987
13219
|
"name": "reach_templates_list-email",
|
|
12988
13220
|
"title": "List email templates",
|
package/src/core/tools/reach.js
CHANGED
|
@@ -2191,16 +2191,16 @@ export default [
|
|
|
2191
2191
|
"group": "reach"
|
|
2192
2192
|
},
|
|
2193
2193
|
{
|
|
2194
|
-
"name": "
|
|
2195
|
-
"title": "Get
|
|
2194
|
+
"name": "reach_profiles_connected-sending-domain",
|
|
2195
|
+
"title": "Get connected sending domain",
|
|
2196
2196
|
"annotations": {
|
|
2197
|
-
"title": "Get
|
|
2197
|
+
"title": "Get connected sending domain",
|
|
2198
2198
|
"readOnlyHint": true,
|
|
2199
2199
|
"destructiveHint": false
|
|
2200
2200
|
},
|
|
2201
|
-
"description": "
|
|
2201
|
+
"description": "Get the sending domain connected to the profile, its verification status and any suspended\nsender addresses.\n\nCampaigns only go out once a domain is connected and active, so this is the cheapest way to\ncheck that precondition before building one. A profile with no domain connected returns the\nsame shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records\nbehind the status, use the DNS status endpoint.",
|
|
2202
2202
|
"method": "GET",
|
|
2203
|
-
"path": "/api/reach/v1/profiles/{profileUuid}/domains
|
|
2203
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
2204
2204
|
"inputSchema": {
|
|
2205
2205
|
"type": "object",
|
|
2206
2206
|
"properties": {
|
|
@@ -2221,16 +2221,82 @@ export default [
|
|
|
2221
2221
|
"group": "reach"
|
|
2222
2222
|
},
|
|
2223
2223
|
{
|
|
2224
|
-
"name": "
|
|
2225
|
-
"title": "
|
|
2224
|
+
"name": "reach_profiles_connect-sending-domain",
|
|
2225
|
+
"title": "Connect sending domain",
|
|
2226
2226
|
"annotations": {
|
|
2227
|
-
"title": "
|
|
2227
|
+
"title": "Connect sending domain",
|
|
2228
|
+
"readOnlyHint": false,
|
|
2229
|
+
"destructiveHint": false
|
|
2230
|
+
},
|
|
2231
|
+
"description": "Connect a sending domain to the profile so emails can be sent from addresses on it.\n\nConnecting does not make the domain ready to send: check the DNS status endpoint next for\nrecords that are still missing. A domain the account owns or has already verified connects\nimmediately. Any other domain starts a TXT ownership verification and returns `409`;\ncomplete the verification in Reach, then retry. Returns `422` when the profile or another\nprofile already has the domain, the domain is blocked, or its ownership cannot be verified.\nAn already connected domain is never replaced.\n\nOn success the sender address of draft and scheduled campaigns, and of published automation\nand double opt-in emails, moves onto the new domain in the background, keeping the part\nbefore the `@`.",
|
|
2232
|
+
"method": "POST",
|
|
2233
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
2234
|
+
"inputSchema": {
|
|
2235
|
+
"type": "object",
|
|
2236
|
+
"properties": {
|
|
2237
|
+
"profileUuid": {
|
|
2238
|
+
"type": "string",
|
|
2239
|
+
"description": "Profile uuid parameter"
|
|
2240
|
+
},
|
|
2241
|
+
"domain": {
|
|
2242
|
+
"type": "string",
|
|
2243
|
+
"description": "domain parameter"
|
|
2244
|
+
}
|
|
2245
|
+
},
|
|
2246
|
+
"required": [
|
|
2247
|
+
"profileUuid",
|
|
2248
|
+
"domain"
|
|
2249
|
+
]
|
|
2250
|
+
},
|
|
2251
|
+
"security": [
|
|
2252
|
+
{
|
|
2253
|
+
"apiToken": []
|
|
2254
|
+
}
|
|
2255
|
+
],
|
|
2256
|
+
"group": "reach"
|
|
2257
|
+
},
|
|
2258
|
+
{
|
|
2259
|
+
"name": "reach_profiles_delete-sending-domain",
|
|
2260
|
+
"title": "Delete sending domain",
|
|
2261
|
+
"annotations": {
|
|
2262
|
+
"title": "Delete sending domain",
|
|
2263
|
+
"readOnlyHint": false,
|
|
2264
|
+
"destructiveHint": true,
|
|
2265
|
+
"idempotentHint": true
|
|
2266
|
+
},
|
|
2267
|
+
"description": "Disconnect the sending domain from the profile.\n\nThe domain record is removed, so the profile has no sending domain afterwards and campaigns\ncannot be sent until a domain is connected again. Sender addresses already stored on\ncampaigns, automations and settings are left untouched and keep pointing at the removed\ndomain. A domain that is not connected to the profile also succeeds, so success is not proof\nthat anything was deleted. DNS records at the DNS provider are not removed. To switch\ndomains, delete this one and connect the new one. Confirm the domain with the customer\nbefore calling.",
|
|
2268
|
+
"method": "DELETE",
|
|
2269
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
2270
|
+
"inputSchema": {
|
|
2271
|
+
"type": "object",
|
|
2272
|
+
"properties": {
|
|
2273
|
+
"profileUuid": {
|
|
2274
|
+
"type": "string",
|
|
2275
|
+
"description": "Profile uuid parameter"
|
|
2276
|
+
}
|
|
2277
|
+
},
|
|
2278
|
+
"required": [
|
|
2279
|
+
"profileUuid"
|
|
2280
|
+
]
|
|
2281
|
+
},
|
|
2282
|
+
"security": [
|
|
2283
|
+
{
|
|
2284
|
+
"apiToken": []
|
|
2285
|
+
}
|
|
2286
|
+
],
|
|
2287
|
+
"group": "reach"
|
|
2288
|
+
},
|
|
2289
|
+
{
|
|
2290
|
+
"name": "reach_profiles_domain-dns-status",
|
|
2291
|
+
"title": "Get profile domain DNS status",
|
|
2292
|
+
"annotations": {
|
|
2293
|
+
"title": "Get profile domain DNS status",
|
|
2228
2294
|
"readOnlyHint": true,
|
|
2229
2295
|
"destructiveHint": false
|
|
2230
2296
|
},
|
|
2231
|
-
"description": "
|
|
2297
|
+
"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.",
|
|
2232
2298
|
"method": "GET",
|
|
2233
|
-
"path": "/api/reach/v1/profiles/{profileUuid}/domains",
|
|
2299
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/domains/dns-status",
|
|
2234
2300
|
"inputSchema": {
|
|
2235
2301
|
"type": "object",
|
|
2236
2302
|
"properties": {
|
|
@@ -2333,6 +2399,172 @@ export default [
|
|
|
2333
2399
|
],
|
|
2334
2400
|
"group": "reach"
|
|
2335
2401
|
},
|
|
2402
|
+
{
|
|
2403
|
+
"name": "reach_profiles_settings",
|
|
2404
|
+
"title": "Get profile settings",
|
|
2405
|
+
"annotations": {
|
|
2406
|
+
"title": "Get profile settings",
|
|
2407
|
+
"readOnlyHint": true,
|
|
2408
|
+
"destructiveHint": false
|
|
2409
|
+
},
|
|
2410
|
+
"description": "Get the profile's saved sender identity and brand details.\n\nRead the default sender before creating a campaign instead of asking the customer, and\nreuse the brand fields when generating email content. Any field can be `null` for a profile\nthat never filled its settings in. This does not check that the sending domain is\nverified, use the connected sending domain endpoint for that.",
|
|
2411
|
+
"method": "GET",
|
|
2412
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/settings",
|
|
2413
|
+
"inputSchema": {
|
|
2414
|
+
"type": "object",
|
|
2415
|
+
"properties": {
|
|
2416
|
+
"profileUuid": {
|
|
2417
|
+
"type": "string",
|
|
2418
|
+
"description": "Profile uuid parameter"
|
|
2419
|
+
}
|
|
2420
|
+
},
|
|
2421
|
+
"required": [
|
|
2422
|
+
"profileUuid"
|
|
2423
|
+
]
|
|
2424
|
+
},
|
|
2425
|
+
"security": [
|
|
2426
|
+
{
|
|
2427
|
+
"apiToken": []
|
|
2428
|
+
}
|
|
2429
|
+
],
|
|
2430
|
+
"group": "reach"
|
|
2431
|
+
},
|
|
2432
|
+
{
|
|
2433
|
+
"name": "reach_profiles_update-settings",
|
|
2434
|
+
"title": "Update profile settings",
|
|
2435
|
+
"annotations": {
|
|
2436
|
+
"title": "Update profile settings",
|
|
2437
|
+
"readOnlyHint": false,
|
|
2438
|
+
"destructiveHint": true,
|
|
2439
|
+
"idempotentHint": true
|
|
2440
|
+
},
|
|
2441
|
+
"description": "Change the profile's default sender and brand details.\n\nSend only the fields to change: every omitted field keeps its value, and `null` or an empty\nstring clears a text field. The default sender is what campaigns created afterwards start\nfrom; existing campaigns keep their own sender. `sender_email` is only the part before the\n`@`, because Reach combines it with the profile's connected sending domain, so an address\noutside that domain cannot be set. Connecting a sending domain is a separate endpoint and\na connected domain cannot be changed here. Returns the settings after the change.",
|
|
2442
|
+
"method": "PATCH",
|
|
2443
|
+
"path": "/api/reach/v1/profiles/{profileUuid}/settings",
|
|
2444
|
+
"inputSchema": {
|
|
2445
|
+
"type": "object",
|
|
2446
|
+
"properties": {
|
|
2447
|
+
"profileUuid": {
|
|
2448
|
+
"type": "string",
|
|
2449
|
+
"description": "Profile uuid parameter"
|
|
2450
|
+
},
|
|
2451
|
+
"brand_name": {
|
|
2452
|
+
"type": "string",
|
|
2453
|
+
"description": "brand_name parameter"
|
|
2454
|
+
},
|
|
2455
|
+
"website_url": {
|
|
2456
|
+
"type": "string",
|
|
2457
|
+
"description": "website_url parameter"
|
|
2458
|
+
},
|
|
2459
|
+
"business_address": {
|
|
2460
|
+
"type": "string",
|
|
2461
|
+
"description": "business_address parameter"
|
|
2462
|
+
},
|
|
2463
|
+
"privacy_policy_url": {
|
|
2464
|
+
"type": "string",
|
|
2465
|
+
"description": "privacy_policy_url parameter"
|
|
2466
|
+
},
|
|
2467
|
+
"accent_color": {
|
|
2468
|
+
"type": "string",
|
|
2469
|
+
"description": "accent_color parameter"
|
|
2470
|
+
},
|
|
2471
|
+
"button_color": {
|
|
2472
|
+
"type": "string",
|
|
2473
|
+
"description": "button_color parameter"
|
|
2474
|
+
},
|
|
2475
|
+
"background_color": {
|
|
2476
|
+
"type": "string",
|
|
2477
|
+
"description": "background_color parameter"
|
|
2478
|
+
},
|
|
2479
|
+
"text_color": {
|
|
2480
|
+
"type": "string",
|
|
2481
|
+
"description": "text_color parameter"
|
|
2482
|
+
},
|
|
2483
|
+
"links_color": {
|
|
2484
|
+
"type": "string",
|
|
2485
|
+
"description": "links_color parameter"
|
|
2486
|
+
},
|
|
2487
|
+
"button_text": {
|
|
2488
|
+
"type": "string",
|
|
2489
|
+
"description": "Button text colour."
|
|
2490
|
+
},
|
|
2491
|
+
"button_corners": {
|
|
2492
|
+
"type": "integer",
|
|
2493
|
+
"description": "button_corners parameter"
|
|
2494
|
+
},
|
|
2495
|
+
"font_family": {
|
|
2496
|
+
"type": "string",
|
|
2497
|
+
"description": "font_family parameter"
|
|
2498
|
+
},
|
|
2499
|
+
"heading_font_family": {
|
|
2500
|
+
"type": "string",
|
|
2501
|
+
"description": "heading_font_family parameter"
|
|
2502
|
+
},
|
|
2503
|
+
"logo_url": {
|
|
2504
|
+
"type": "string",
|
|
2505
|
+
"description": "Public image URL. Logo uploads are not supported."
|
|
2506
|
+
},
|
|
2507
|
+
"social_links": {
|
|
2508
|
+
"type": "array",
|
|
2509
|
+
"description": "social_links parameter",
|
|
2510
|
+
"items": {
|
|
2511
|
+
"type": "string",
|
|
2512
|
+
"description": "social_links parameter"
|
|
2513
|
+
}
|
|
2514
|
+
},
|
|
2515
|
+
"socials": {
|
|
2516
|
+
"type": "object",
|
|
2517
|
+
"description": "Social profile links keyed by platform.",
|
|
2518
|
+
"properties": {}
|
|
2519
|
+
},
|
|
2520
|
+
"about": {
|
|
2521
|
+
"type": "string",
|
|
2522
|
+
"description": "about parameter"
|
|
2523
|
+
},
|
|
2524
|
+
"keywords": {
|
|
2525
|
+
"type": "array",
|
|
2526
|
+
"description": "keywords parameter",
|
|
2527
|
+
"items": {
|
|
2528
|
+
"type": "string",
|
|
2529
|
+
"description": "keywords parameter"
|
|
2530
|
+
}
|
|
2531
|
+
},
|
|
2532
|
+
"topics": {
|
|
2533
|
+
"type": "array",
|
|
2534
|
+
"description": "topics parameter",
|
|
2535
|
+
"items": {
|
|
2536
|
+
"type": "string",
|
|
2537
|
+
"description": "topics parameter"
|
|
2538
|
+
}
|
|
2539
|
+
},
|
|
2540
|
+
"selling_points": {
|
|
2541
|
+
"type": "array",
|
|
2542
|
+
"description": "selling_points parameter",
|
|
2543
|
+
"items": {
|
|
2544
|
+
"type": "string",
|
|
2545
|
+
"description": "selling_points parameter"
|
|
2546
|
+
}
|
|
2547
|
+
},
|
|
2548
|
+
"sender_name": {
|
|
2549
|
+
"type": "string",
|
|
2550
|
+
"description": "Default sender name. Letters, numbers and spaces only."
|
|
2551
|
+
},
|
|
2552
|
+
"sender_email": {
|
|
2553
|
+
"type": "string",
|
|
2554
|
+
"description": "Part of the default sender address before the `@`, for example `hello`. Never send a\nfull address: Reach adds the profile's connected sending domain itself."
|
|
2555
|
+
}
|
|
2556
|
+
},
|
|
2557
|
+
"required": [
|
|
2558
|
+
"profileUuid"
|
|
2559
|
+
]
|
|
2560
|
+
},
|
|
2561
|
+
"security": [
|
|
2562
|
+
{
|
|
2563
|
+
"apiToken": []
|
|
2564
|
+
}
|
|
2565
|
+
],
|
|
2566
|
+
"group": "reach"
|
|
2567
|
+
},
|
|
2336
2568
|
{
|
|
2337
2569
|
"name": "reach_templates_list-email",
|
|
2338
2570
|
"title": "List email templates",
|