@apteva/integrations 0.2.3 → 0.3.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/package.json +1 -1
- package/src/apps/activecampaign.json +209 -0
- package/src/apps/activecollab.json +417 -0
- package/src/apps/airtable.json +235 -0
- package/src/apps/alpaca-trading.json +1554 -0
- package/src/apps/amadeus.json +225 -0
- package/src/apps/anthropic-api.json +96 -0
- package/src/apps/apify.json +203 -0
- package/src/apps/apollo.json +748 -0
- package/src/apps/apple-podcasts.json +116 -0
- package/src/apps/archive-api.json +104 -0
- package/src/apps/archive.json +151 -0
- package/src/apps/arduino-cloud.json +301 -0
- package/src/apps/arest.json +492 -0
- package/src/apps/asana.json +184 -0
- package/src/apps/ashby.json +176 -0
- package/src/apps/assemblyai.json +163 -0
- package/src/apps/attio.json +243 -0
- package/src/apps/aws-cloudfront.json +132 -0
- package/src/apps/aws-dynamodb.json +295 -0
- package/src/apps/aws-ec2.json +184 -0
- package/src/apps/aws-lambda.json +361 -0
- package/src/apps/aws-route53.json +110 -0
- package/src/apps/aws-s3.json +303 -0
- package/src/apps/aws-ses.json +556 -0
- package/src/apps/aws-sns.json +217 -0
- package/src/apps/aws-sqs.json +234 -0
- package/src/apps/axiom.json +123 -0
- package/src/apps/beehiiv.json +252 -0
- package/src/apps/binance-trading.json +555 -0
- package/src/apps/bitly.json +175 -0
- package/src/apps/bloobirds.json +246 -0
- package/src/apps/bluesky.json +201 -0
- package/src/apps/blynk.json +316 -0
- package/src/apps/booking-com.json +144 -0
- package/src/apps/box.json +289 -0
- package/src/apps/brevo.json +1423 -0
- package/src/apps/browse-ai.json +148 -0
- package/src/apps/bunny-cdn.json +330 -0
- package/src/apps/bunny-stream.json +387 -0
- package/src/apps/cal-com.json +240 -0
- package/src/apps/calendly.json +578 -0
- package/src/apps/calflow-calendar.json +706 -0
- package/src/apps/callrail.json +190 -0
- package/src/apps/canva.json +197 -0
- package/src/apps/cartesia.json +201 -0
- package/src/apps/castbase.json +753 -0
- package/src/apps/chargebee.json +226 -0
- package/src/apps/cleanster.json +359 -0
- package/src/apps/clicksend.json +278 -0
- package/src/apps/clickup.json +266 -0
- package/src/apps/clipkit.json +517 -0
- package/src/apps/close.json +359 -0
- package/src/apps/cloudflare.json +329 -0
- package/src/apps/cloudinary.json +164 -0
- package/src/apps/coda.json +288 -0
- package/src/apps/cohere.json +158 -0
- package/src/apps/coinbase.json +268 -0
- package/src/apps/composio.json +146 -0
- package/src/apps/confluence.json +270 -0
- package/src/apps/consensus.json +879 -0
- package/src/apps/contabo.json +733 -0
- package/src/apps/convertkit.json +211 -0
- package/src/apps/core-image.json +426 -0
- package/src/apps/core-video.json +1246 -0
- package/src/apps/craftcloud.json +298 -0
- package/src/apps/datadog.json +401 -0
- package/src/apps/dataforseo.json +1273 -0
- package/src/apps/deepseek.json +150 -0
- package/src/apps/dialpad.json +229 -0
- package/src/apps/discord.json +239 -0
- package/src/apps/dnsimple.json +405 -0
- package/src/apps/docusign.json +214 -0
- package/src/apps/docx.json +282 -0
- package/src/apps/dropbox.json +185 -0
- package/src/apps/duffel.json +231 -0
- package/src/apps/dux-soup.json +694 -0
- package/src/apps/dynadot.json +250 -0
- package/src/apps/elevenlabs.json +327 -0
- package/src/apps/eventbrite-events.json +598 -0
- package/src/apps/facebook-ads.json +1399 -0
- package/src/apps/facebook-api.json +282 -0
- package/src/apps/fal-ai.json +400 -0
- package/src/apps/fathom.json +86 -0
- package/src/apps/figma.json +162 -0
- package/src/apps/filestack.json +159 -0
- package/src/apps/firebase.json +271 -0
- package/src/apps/firecrawl.json +278 -0
- package/src/apps/folk.json +564 -0
- package/src/apps/forecast-app.json +377 -0
- package/src/apps/freshdesk.json +283 -0
- package/src/apps/gemini.json +528 -0
- package/src/apps/ghost.json +439 -0
- package/src/apps/gigs-marketplace.json +1442 -0
- package/src/apps/github.json +1479 -47
- package/src/apps/gitlab.json +448 -0
- package/src/apps/gmail.json +839 -28
- package/src/apps/gohighlevel.json +596 -0
- package/src/apps/google-ads.json +270 -0
- package/src/apps/google-calendar.json +996 -36
- package/src/apps/google-docs.json +278 -0
- package/src/apps/google-drive.json +360 -0
- package/src/apps/google-maps.json +473 -0
- package/src/apps/google-sheets.json +330 -0
- package/src/apps/gooten.json +411 -0
- package/src/apps/gravity-forms.json +385 -0
- package/src/apps/gusto.json +171 -0
- package/src/apps/hackernews.json +221 -0
- package/src/apps/harmonic.json +86 -0
- package/src/apps/helpscout.json +664 -0
- package/src/apps/hetzner.json +658 -0
- package/src/apps/heygen.json +184 -0
- package/src/apps/heyreach.json +388 -0
- package/src/apps/hospitable.json +340 -0
- package/src/apps/hostinger.json +374 -0
- package/src/apps/hubspot.json +682 -0
- package/src/apps/huggingface.json +97 -0
- package/src/apps/hunter.json +504 -0
- package/src/apps/ig-trading.json +849 -0
- package/src/apps/imaterialise.json +349 -0
- package/src/apps/instagram-api.json +538 -0
- package/src/apps/intercom.json +648 -0
- package/src/apps/jira.json +226 -0
- package/src/apps/klaviyo.json +199 -0
- package/src/apps/kling-ai.json +206 -0
- package/src/apps/kraken.json +870 -0
- package/src/apps/late.json +1056 -0
- package/src/apps/leadpages.json +243 -0
- package/src/apps/learning-platform.json +2244 -0
- package/src/apps/linear.json +184 -57
- package/src/apps/linkedin.json +179 -0
- package/src/apps/listen-notes.json +136 -0
- package/src/apps/lnk-bio.json +125 -0
- package/src/apps/loom.json +188 -0
- package/src/apps/luma.json +280 -0
- package/src/apps/mailchimp.json +238 -0
- package/src/apps/mailgun.json +310 -0
- package/src/apps/manychat.json +312 -0
- package/src/apps/marin-software.json +843 -0
- package/src/apps/media-downloader.json +157 -0
- package/src/apps/meetup-events.json +361 -0
- package/src/apps/meshy.json +248 -0
- package/src/apps/microsoft-teams.json +162 -0
- package/src/apps/monday.json +213 -0
- package/src/apps/mongodb-atlas.json +467 -0
- package/src/apps/namecheap.json +252 -0
- package/src/apps/nexar.json +289 -0
- package/src/apps/notion.json +530 -50
- package/src/apps/omnikit-analytics.json +374 -0
- package/src/apps/omnikit-api-gateway.json +660 -0
- package/src/apps/omnikit-billing.json +1781 -0
- package/src/apps/omnikit-cms.json +899 -0
- package/src/apps/omnikit-functions.json +329 -0
- package/src/apps/omnikit-intelligence.json +650 -0
- package/src/apps/omnikit-management.json +214 -0
- package/src/apps/omnikit-media.json +646 -0
- package/src/apps/omnikit-messaging.json +1826 -0
- package/src/apps/omnikit-redirects.json +209 -0
- package/src/apps/omnikit-webhooks.json +269 -0
- package/src/apps/omnikit-workflows.json +323 -0
- package/src/apps/openai-api.json +462 -0
- package/src/apps/openmeteo-weather.json +75 -0
- package/src/apps/optinmonster.json +244 -0
- package/src/apps/paidkit.json +1218 -0
- package/src/apps/paypal.json +254 -0
- package/src/apps/pdf.json +366 -0
- package/src/apps/pipedrive.json +255 -0
- package/src/apps/polymarket.json +653 -0
- package/src/apps/porkbun.json +417 -0
- package/src/apps/portfolio.json +501 -0
- package/src/apps/postmark.json +257 -0
- package/src/apps/printful.json +273 -0
- package/src/apps/printify.json +295 -0
- package/src/apps/producthunt.json +346 -0
- package/src/apps/pushover-notifications.json +113 -0
- package/src/apps/qonto.json +366 -0
- package/src/apps/quickbooks.json +234 -0
- package/src/apps/replicate.json +106 -0
- package/src/apps/rss.json +281 -0
- package/src/apps/salesflow.json +538 -0
- package/src/apps/salesforce-crm.json +216 -0
- package/src/apps/sap.json +256 -0
- package/src/apps/scaleway.json +911 -0
- package/src/apps/sculpteo.json +234 -0
- package/src/apps/sendgrid-email.json +233 -0
- package/src/apps/sendgrid.json +160 -35
- package/src/apps/shapeways.json +188 -0
- package/src/apps/shopify.json +1217 -0
- package/src/apps/skai.json +779 -0
- package/src/apps/slack.json +228 -38
- package/src/apps/slant3d.json +231 -0
- package/src/apps/slides.json +760 -0
- package/src/apps/smartly.json +504 -0
- package/src/apps/snov.json +467 -0
- package/src/apps/socialcast.json +553 -63
- package/src/apps/square.json +274 -0
- package/src/apps/storage-management.json +788 -0
- package/src/apps/storylane.json +180 -0
- package/src/apps/strapi.json +338 -0
- package/src/apps/stripe-payments.json +847 -0
- package/src/apps/stripe.json +472 -35
- package/src/apps/supabase.json +169 -0
- package/src/apps/supademo.json +115 -0
- package/src/apps/taskflow.json +714 -0
- package/src/apps/teamwork.json +457 -0
- package/src/apps/telegram.json +444 -0
- package/src/apps/thinger.json +458 -0
- package/src/apps/ticktick.json +169 -0
- package/src/apps/tiktok-api.json +406 -0
- package/src/apps/todoist.json +151 -0
- package/src/apps/together.json +123 -0
- package/src/apps/torrent.json +267 -0
- package/src/apps/trading.json +1012 -0
- package/src/apps/trading212.json +383 -0
- package/src/apps/trello.json +205 -0
- package/src/apps/tripo.json +157 -0
- package/src/apps/twilio.json +1008 -0
- package/src/apps/twitter-ads.json +875 -0
- package/src/apps/twitter-api.json +1151 -0
- package/src/apps/twitterapiio.json +548 -0
- package/src/apps/typeform.json +210 -0
- package/src/apps/vidforge.json +1020 -0
- package/src/apps/vonage.json +394 -0
- package/src/apps/vultr.json +225 -0
- package/src/apps/webflow.json +223 -0
- package/src/apps/wise.json +273 -0
- package/src/apps/wistia.json +283 -0
- package/src/apps/woocommerce.json +288 -0
- package/src/apps/wordpress.json +1675 -0
- package/src/apps/xero.json +257 -0
- package/src/apps/youtube-api.json +861 -0
- package/src/apps/zendesk.json +295 -0
- package/src/apps/zite.json +173 -0
- package/src/apps/zoho-crm.json +386 -0
- package/src/apps/zoo.json +193 -0
- package/src/apps/zoom.json +334 -0
|
@@ -0,0 +1,1423 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "brevo",
|
|
3
|
+
"name": "Brevo (Sendinblue)",
|
|
4
|
+
"description": "Complete email marketing and transactional email platform. Send emails, SMS, manage contacts, create campaigns, and track engagement.",
|
|
5
|
+
"logo": "https://www.brevo.com/favicon.ico",
|
|
6
|
+
"categories": [
|
|
7
|
+
"email",
|
|
8
|
+
"sms",
|
|
9
|
+
"marketing",
|
|
10
|
+
"transactional",
|
|
11
|
+
"campaigns",
|
|
12
|
+
"contacts",
|
|
13
|
+
"automation",
|
|
14
|
+
"analytics"
|
|
15
|
+
],
|
|
16
|
+
"base_url": "https://api.brevo.com/v3",
|
|
17
|
+
"auth": {
|
|
18
|
+
"types": [
|
|
19
|
+
"api_key"
|
|
20
|
+
],
|
|
21
|
+
"headers": {
|
|
22
|
+
"api-key": "{{token}}"
|
|
23
|
+
},
|
|
24
|
+
"credential_fields": [
|
|
25
|
+
{
|
|
26
|
+
"name": "api_key",
|
|
27
|
+
"label": "Api_key",
|
|
28
|
+
"description": "Your Brevo API Key (found in SMTP & API settings)"
|
|
29
|
+
}
|
|
30
|
+
]
|
|
31
|
+
},
|
|
32
|
+
"tools": [
|
|
33
|
+
{
|
|
34
|
+
"name": "send_transactional_email",
|
|
35
|
+
"description": "Send a transactional email immediately. Use for password resets, order confirmations, notifications, etc.",
|
|
36
|
+
"method": "POST",
|
|
37
|
+
"path": "/smtp/email",
|
|
38
|
+
"input_schema": {
|
|
39
|
+
"type": "object",
|
|
40
|
+
"properties": {
|
|
41
|
+
"sender": {
|
|
42
|
+
"type": "object",
|
|
43
|
+
"description": "Sender information",
|
|
44
|
+
"properties": {
|
|
45
|
+
"name": {
|
|
46
|
+
"type": "string",
|
|
47
|
+
"description": "Sender name"
|
|
48
|
+
},
|
|
49
|
+
"email": {
|
|
50
|
+
"type": "string",
|
|
51
|
+
"description": "Sender email address"
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
"required": [
|
|
55
|
+
"email"
|
|
56
|
+
]
|
|
57
|
+
},
|
|
58
|
+
"to": {
|
|
59
|
+
"type": "array",
|
|
60
|
+
"description": "List of recipients",
|
|
61
|
+
"items": {
|
|
62
|
+
"type": "object",
|
|
63
|
+
"properties": {
|
|
64
|
+
"email": {
|
|
65
|
+
"type": "string"
|
|
66
|
+
},
|
|
67
|
+
"name": {
|
|
68
|
+
"type": "string"
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
"required": [
|
|
72
|
+
"email"
|
|
73
|
+
]
|
|
74
|
+
}
|
|
75
|
+
},
|
|
76
|
+
"subject": {
|
|
77
|
+
"type": "string",
|
|
78
|
+
"description": "Email subject line"
|
|
79
|
+
},
|
|
80
|
+
"htmlContent": {
|
|
81
|
+
"type": "string",
|
|
82
|
+
"description": "HTML content of the email"
|
|
83
|
+
},
|
|
84
|
+
"textContent": {
|
|
85
|
+
"type": "string",
|
|
86
|
+
"description": "Plain text content of the email"
|
|
87
|
+
},
|
|
88
|
+
"templateId": {
|
|
89
|
+
"type": "integer",
|
|
90
|
+
"description": "ID of the Brevo template to use (optional, use instead of htmlContent)"
|
|
91
|
+
},
|
|
92
|
+
"params": {
|
|
93
|
+
"type": "object",
|
|
94
|
+
"description": "Template variables for personalization"
|
|
95
|
+
},
|
|
96
|
+
"replyTo": {
|
|
97
|
+
"type": "object",
|
|
98
|
+
"description": "Reply-to address",
|
|
99
|
+
"properties": {
|
|
100
|
+
"email": {
|
|
101
|
+
"type": "string"
|
|
102
|
+
},
|
|
103
|
+
"name": {
|
|
104
|
+
"type": "string"
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
},
|
|
108
|
+
"tags": {
|
|
109
|
+
"type": "array",
|
|
110
|
+
"items": {
|
|
111
|
+
"type": "string"
|
|
112
|
+
},
|
|
113
|
+
"description": "Tags for categorizing the email"
|
|
114
|
+
}
|
|
115
|
+
},
|
|
116
|
+
"required": [
|
|
117
|
+
"sender",
|
|
118
|
+
"to"
|
|
119
|
+
]
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"name": "create_contact",
|
|
124
|
+
"description": "Create a new contact in Brevo. Attributes must be in UPPERCASE (e.g., FIRSTNAME, LASTNAME). Attributes must exist in your account - use brevo-list-attributes to see available attributes.",
|
|
125
|
+
"method": "POST",
|
|
126
|
+
"path": "/contacts",
|
|
127
|
+
"input_schema": {
|
|
128
|
+
"type": "object",
|
|
129
|
+
"properties": {
|
|
130
|
+
"email": {
|
|
131
|
+
"type": "string",
|
|
132
|
+
"description": "Email address of the contact (required)"
|
|
133
|
+
},
|
|
134
|
+
"attributes": {
|
|
135
|
+
"type": "object",
|
|
136
|
+
"description": "Contact attributes in UPPERCASE, e.g., {\"FIRSTNAME\": \"John\", \"LASTNAME\": \"Doe\", \"SMS\": \"+33612345678\"}"
|
|
137
|
+
},
|
|
138
|
+
"listIds": {
|
|
139
|
+
"type": "array",
|
|
140
|
+
"items": {
|
|
141
|
+
"type": "integer"
|
|
142
|
+
},
|
|
143
|
+
"description": "List IDs to add the contact to"
|
|
144
|
+
},
|
|
145
|
+
"updateEnabled": {
|
|
146
|
+
"type": "boolean",
|
|
147
|
+
"default": false,
|
|
148
|
+
"description": "Update contact if already exists"
|
|
149
|
+
},
|
|
150
|
+
"smtpBlacklistSender": {
|
|
151
|
+
"type": "array",
|
|
152
|
+
"items": {
|
|
153
|
+
"type": "string"
|
|
154
|
+
},
|
|
155
|
+
"description": "Sender emails to blacklist for this contact"
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
"required": [
|
|
159
|
+
"email"
|
|
160
|
+
]
|
|
161
|
+
}
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"name": "get_contact",
|
|
165
|
+
"description": "Get contact details by email address or ID",
|
|
166
|
+
"method": "GET",
|
|
167
|
+
"path": "/contacts/%7B%7Bidentifier%7D%7D",
|
|
168
|
+
"input_schema": {
|
|
169
|
+
"type": "object",
|
|
170
|
+
"properties": {
|
|
171
|
+
"identifier": {
|
|
172
|
+
"type": "string",
|
|
173
|
+
"description": "Email address or contact ID"
|
|
174
|
+
}
|
|
175
|
+
},
|
|
176
|
+
"required": [
|
|
177
|
+
"identifier"
|
|
178
|
+
]
|
|
179
|
+
}
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
"name": "update_contact",
|
|
183
|
+
"description": "Update an existing contact's attributes or list memberships. Attributes must be passed in UPPERCASE (e.g., FIRSTNAME, LASTNAME). Attributes must exist in your Brevo account - use brevo-list-attributes to see available attributes.",
|
|
184
|
+
"method": "PUT",
|
|
185
|
+
"path": "/contacts/%7B%7Bidentifier%7D%7D",
|
|
186
|
+
"input_schema": {
|
|
187
|
+
"type": "object",
|
|
188
|
+
"properties": {
|
|
189
|
+
"identifier": {
|
|
190
|
+
"type": "string",
|
|
191
|
+
"description": "Email address or contact ID to update (required)"
|
|
192
|
+
},
|
|
193
|
+
"attributes": {
|
|
194
|
+
"type": "object",
|
|
195
|
+
"description": "Contact attributes to update in UPPERCASE, e.g., {\"FIRSTNAME\": \"John\", \"LASTNAME\": \"Doe\", \"SMS\": \"+33612345678\"}"
|
|
196
|
+
},
|
|
197
|
+
"listIds": {
|
|
198
|
+
"type": "array",
|
|
199
|
+
"items": {
|
|
200
|
+
"type": "integer"
|
|
201
|
+
},
|
|
202
|
+
"description": "List IDs to add the contact to"
|
|
203
|
+
},
|
|
204
|
+
"unlinkListIds": {
|
|
205
|
+
"type": "array",
|
|
206
|
+
"items": {
|
|
207
|
+
"type": "integer"
|
|
208
|
+
},
|
|
209
|
+
"description": "List IDs to remove the contact from"
|
|
210
|
+
},
|
|
211
|
+
"emailBlacklisted": {
|
|
212
|
+
"type": "boolean",
|
|
213
|
+
"description": "Set to true to blacklist the contact for emails"
|
|
214
|
+
},
|
|
215
|
+
"smsBlacklisted": {
|
|
216
|
+
"type": "boolean",
|
|
217
|
+
"description": "Set to true to blacklist the contact for SMS"
|
|
218
|
+
},
|
|
219
|
+
"smtpBlacklistSender": {
|
|
220
|
+
"type": "array",
|
|
221
|
+
"items": {
|
|
222
|
+
"type": "string"
|
|
223
|
+
},
|
|
224
|
+
"description": "Sender emails to blacklist for this contact"
|
|
225
|
+
}
|
|
226
|
+
},
|
|
227
|
+
"required": [
|
|
228
|
+
"identifier"
|
|
229
|
+
]
|
|
230
|
+
}
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "delete_contact",
|
|
234
|
+
"description": "Permanently delete a contact from Brevo",
|
|
235
|
+
"method": "DELETE",
|
|
236
|
+
"path": "/contacts/%7B%7Bidentifier%7D%7D",
|
|
237
|
+
"input_schema": {
|
|
238
|
+
"type": "object",
|
|
239
|
+
"properties": {
|
|
240
|
+
"identifier": {
|
|
241
|
+
"type": "string",
|
|
242
|
+
"description": "Email address or contact ID to delete"
|
|
243
|
+
}
|
|
244
|
+
},
|
|
245
|
+
"required": [
|
|
246
|
+
"identifier"
|
|
247
|
+
]
|
|
248
|
+
}
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "list_contacts",
|
|
252
|
+
"description": "Get all contacts with optional filtering and pagination",
|
|
253
|
+
"method": "GET",
|
|
254
|
+
"path": "/contacts",
|
|
255
|
+
"input_schema": {
|
|
256
|
+
"type": "object",
|
|
257
|
+
"properties": {
|
|
258
|
+
"limit": {
|
|
259
|
+
"type": "integer",
|
|
260
|
+
"default": 50,
|
|
261
|
+
"description": "Number of contacts to return (max 1000)"
|
|
262
|
+
},
|
|
263
|
+
"offset": {
|
|
264
|
+
"type": "integer",
|
|
265
|
+
"default": 0,
|
|
266
|
+
"description": "Index of the first contact to return"
|
|
267
|
+
},
|
|
268
|
+
"modifiedSince": {
|
|
269
|
+
"type": "string",
|
|
270
|
+
"description": "Filter contacts modified after this date (YYYY-MM-DD)"
|
|
271
|
+
},
|
|
272
|
+
"sort": {
|
|
273
|
+
"type": "string",
|
|
274
|
+
"enum": [
|
|
275
|
+
"asc",
|
|
276
|
+
"desc"
|
|
277
|
+
],
|
|
278
|
+
"default": "desc",
|
|
279
|
+
"description": "Sort order by creation date"
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
},
|
|
284
|
+
{
|
|
285
|
+
"name": "create_list",
|
|
286
|
+
"description": "Create a new contact list for organizing and segmenting contacts",
|
|
287
|
+
"method": "POST",
|
|
288
|
+
"path": "/contacts/lists",
|
|
289
|
+
"input_schema": {
|
|
290
|
+
"type": "object",
|
|
291
|
+
"properties": {
|
|
292
|
+
"name": {
|
|
293
|
+
"type": "string",
|
|
294
|
+
"description": "Name of the list"
|
|
295
|
+
},
|
|
296
|
+
"folderId": {
|
|
297
|
+
"type": "integer",
|
|
298
|
+
"description": "ID of the folder to place the list in"
|
|
299
|
+
}
|
|
300
|
+
},
|
|
301
|
+
"required": [
|
|
302
|
+
"name",
|
|
303
|
+
"folderId"
|
|
304
|
+
]
|
|
305
|
+
}
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"name": "get_lists",
|
|
309
|
+
"description": "Get all contact lists",
|
|
310
|
+
"method": "GET",
|
|
311
|
+
"path": "/contacts/lists",
|
|
312
|
+
"input_schema": {
|
|
313
|
+
"type": "object",
|
|
314
|
+
"properties": {
|
|
315
|
+
"limit": {
|
|
316
|
+
"type": "integer",
|
|
317
|
+
"default": 10,
|
|
318
|
+
"description": "Number of lists to return"
|
|
319
|
+
},
|
|
320
|
+
"offset": {
|
|
321
|
+
"type": "integer",
|
|
322
|
+
"default": 0,
|
|
323
|
+
"description": "Index of the first list"
|
|
324
|
+
},
|
|
325
|
+
"sort": {
|
|
326
|
+
"type": "string",
|
|
327
|
+
"enum": [
|
|
328
|
+
"asc",
|
|
329
|
+
"desc"
|
|
330
|
+
],
|
|
331
|
+
"default": "desc"
|
|
332
|
+
}
|
|
333
|
+
}
|
|
334
|
+
}
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"name": "add_contacts_to_list",
|
|
338
|
+
"description": "Add multiple contacts to a list by email addresses",
|
|
339
|
+
"method": "POST",
|
|
340
|
+
"path": "/contacts/lists/%7B%7BlistId%7D%7D/contacts/add",
|
|
341
|
+
"input_schema": {
|
|
342
|
+
"type": "object",
|
|
343
|
+
"properties": {
|
|
344
|
+
"listId": {
|
|
345
|
+
"type": "integer",
|
|
346
|
+
"description": "ID of the list"
|
|
347
|
+
},
|
|
348
|
+
"emails": {
|
|
349
|
+
"type": "array",
|
|
350
|
+
"items": {
|
|
351
|
+
"type": "string"
|
|
352
|
+
},
|
|
353
|
+
"description": "Email addresses to add"
|
|
354
|
+
}
|
|
355
|
+
},
|
|
356
|
+
"required": [
|
|
357
|
+
"listId",
|
|
358
|
+
"emails"
|
|
359
|
+
]
|
|
360
|
+
}
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"name": "remove_contacts_from_list",
|
|
364
|
+
"description": "Remove multiple contacts from a list",
|
|
365
|
+
"method": "POST",
|
|
366
|
+
"path": "/contacts/lists/%7B%7BlistId%7D%7D/contacts/remove",
|
|
367
|
+
"input_schema": {
|
|
368
|
+
"type": "object",
|
|
369
|
+
"properties": {
|
|
370
|
+
"listId": {
|
|
371
|
+
"type": "integer",
|
|
372
|
+
"description": "ID of the list"
|
|
373
|
+
},
|
|
374
|
+
"emails": {
|
|
375
|
+
"type": "array",
|
|
376
|
+
"items": {
|
|
377
|
+
"type": "string"
|
|
378
|
+
},
|
|
379
|
+
"description": "Email addresses to remove"
|
|
380
|
+
}
|
|
381
|
+
},
|
|
382
|
+
"required": [
|
|
383
|
+
"listId",
|
|
384
|
+
"emails"
|
|
385
|
+
]
|
|
386
|
+
}
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "get_templates",
|
|
390
|
+
"description": "Get all email templates",
|
|
391
|
+
"method": "GET",
|
|
392
|
+
"path": "/smtp/templates",
|
|
393
|
+
"input_schema": {
|
|
394
|
+
"type": "object",
|
|
395
|
+
"properties": {
|
|
396
|
+
"templateStatus": {
|
|
397
|
+
"type": "boolean",
|
|
398
|
+
"description": "Filter by active (true) or inactive (false) templates"
|
|
399
|
+
},
|
|
400
|
+
"limit": {
|
|
401
|
+
"type": "integer",
|
|
402
|
+
"default": 50,
|
|
403
|
+
"description": "Number of templates to return"
|
|
404
|
+
},
|
|
405
|
+
"offset": {
|
|
406
|
+
"type": "integer",
|
|
407
|
+
"default": 0,
|
|
408
|
+
"description": "Index of first template"
|
|
409
|
+
},
|
|
410
|
+
"sort": {
|
|
411
|
+
"type": "string",
|
|
412
|
+
"enum": [
|
|
413
|
+
"asc",
|
|
414
|
+
"desc"
|
|
415
|
+
],
|
|
416
|
+
"default": "desc"
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
"name": "get_template",
|
|
423
|
+
"description": "Get a specific email template by ID",
|
|
424
|
+
"method": "GET",
|
|
425
|
+
"path": "/smtp/templates/%7B%7BtemplateId%7D%7D",
|
|
426
|
+
"input_schema": {
|
|
427
|
+
"type": "object",
|
|
428
|
+
"properties": {
|
|
429
|
+
"templateId": {
|
|
430
|
+
"type": "integer",
|
|
431
|
+
"description": "Template ID"
|
|
432
|
+
}
|
|
433
|
+
},
|
|
434
|
+
"required": [
|
|
435
|
+
"templateId"
|
|
436
|
+
]
|
|
437
|
+
}
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
"name": "create_template",
|
|
441
|
+
"description": "Create a new email template",
|
|
442
|
+
"method": "POST",
|
|
443
|
+
"path": "/smtp/templates",
|
|
444
|
+
"input_schema": {
|
|
445
|
+
"type": "object",
|
|
446
|
+
"properties": {
|
|
447
|
+
"templateName": {
|
|
448
|
+
"type": "string",
|
|
449
|
+
"description": "Name of the template"
|
|
450
|
+
},
|
|
451
|
+
"sender": {
|
|
452
|
+
"type": "object",
|
|
453
|
+
"description": "Sender details",
|
|
454
|
+
"properties": {
|
|
455
|
+
"name": {
|
|
456
|
+
"type": "string"
|
|
457
|
+
},
|
|
458
|
+
"email": {
|
|
459
|
+
"type": "string"
|
|
460
|
+
}
|
|
461
|
+
},
|
|
462
|
+
"required": [
|
|
463
|
+
"email"
|
|
464
|
+
]
|
|
465
|
+
},
|
|
466
|
+
"subject": {
|
|
467
|
+
"type": "string",
|
|
468
|
+
"description": "Email subject line"
|
|
469
|
+
},
|
|
470
|
+
"htmlContent": {
|
|
471
|
+
"type": "string",
|
|
472
|
+
"description": "HTML content of the template"
|
|
473
|
+
},
|
|
474
|
+
"isActive": {
|
|
475
|
+
"type": "boolean",
|
|
476
|
+
"default": true,
|
|
477
|
+
"description": "Whether the template is active"
|
|
478
|
+
},
|
|
479
|
+
"replyTo": {
|
|
480
|
+
"type": "string",
|
|
481
|
+
"description": "Reply-to email address"
|
|
482
|
+
},
|
|
483
|
+
"toField": {
|
|
484
|
+
"type": "string",
|
|
485
|
+
"description": "To field personalization (e.g., {{contact.FIRSTNAME}})"
|
|
486
|
+
}
|
|
487
|
+
},
|
|
488
|
+
"required": [
|
|
489
|
+
"templateName",
|
|
490
|
+
"sender",
|
|
491
|
+
"subject",
|
|
492
|
+
"htmlContent"
|
|
493
|
+
]
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
{
|
|
497
|
+
"name": "update_template",
|
|
498
|
+
"description": "Update an existing email template",
|
|
499
|
+
"method": "PUT",
|
|
500
|
+
"path": "/smtp/templates/%7B%7BtemplateId%7D%7D",
|
|
501
|
+
"input_schema": {
|
|
502
|
+
"type": "object",
|
|
503
|
+
"properties": {
|
|
504
|
+
"templateId": {
|
|
505
|
+
"type": "integer",
|
|
506
|
+
"description": "Template ID to update"
|
|
507
|
+
},
|
|
508
|
+
"templateName": {
|
|
509
|
+
"type": "string",
|
|
510
|
+
"description": "New template name"
|
|
511
|
+
},
|
|
512
|
+
"sender": {
|
|
513
|
+
"type": "object",
|
|
514
|
+
"description": "Sender details"
|
|
515
|
+
},
|
|
516
|
+
"subject": {
|
|
517
|
+
"type": "string",
|
|
518
|
+
"description": "New subject line"
|
|
519
|
+
},
|
|
520
|
+
"htmlContent": {
|
|
521
|
+
"type": "string",
|
|
522
|
+
"description": "New HTML content"
|
|
523
|
+
},
|
|
524
|
+
"isActive": {
|
|
525
|
+
"type": "boolean",
|
|
526
|
+
"description": "Whether template is active"
|
|
527
|
+
},
|
|
528
|
+
"replyTo": {
|
|
529
|
+
"type": "string",
|
|
530
|
+
"description": "Reply-to email"
|
|
531
|
+
}
|
|
532
|
+
},
|
|
533
|
+
"required": [
|
|
534
|
+
"templateId"
|
|
535
|
+
]
|
|
536
|
+
}
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
"name": "delete_template",
|
|
540
|
+
"description": "Delete an email template",
|
|
541
|
+
"method": "DELETE",
|
|
542
|
+
"path": "/smtp/templates/%7B%7BtemplateId%7D%7D",
|
|
543
|
+
"input_schema": {
|
|
544
|
+
"type": "object",
|
|
545
|
+
"properties": {
|
|
546
|
+
"templateId": {
|
|
547
|
+
"type": "integer",
|
|
548
|
+
"description": "Template ID to delete"
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
"required": [
|
|
552
|
+
"templateId"
|
|
553
|
+
]
|
|
554
|
+
}
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"name": "send_sms",
|
|
558
|
+
"description": "Send a transactional SMS message",
|
|
559
|
+
"method": "POST",
|
|
560
|
+
"path": "/transactionalSMS/sms",
|
|
561
|
+
"input_schema": {
|
|
562
|
+
"type": "object",
|
|
563
|
+
"properties": {
|
|
564
|
+
"sender": {
|
|
565
|
+
"type": "string",
|
|
566
|
+
"description": "Sender name (max 11 chars) or phone number"
|
|
567
|
+
},
|
|
568
|
+
"recipient": {
|
|
569
|
+
"type": "string",
|
|
570
|
+
"description": "Recipient phone number with country code (e.g., +33612345678)"
|
|
571
|
+
},
|
|
572
|
+
"content": {
|
|
573
|
+
"type": "string",
|
|
574
|
+
"description": "SMS message content"
|
|
575
|
+
},
|
|
576
|
+
"type": {
|
|
577
|
+
"type": "string",
|
|
578
|
+
"enum": [
|
|
579
|
+
"transactional",
|
|
580
|
+
"marketing"
|
|
581
|
+
],
|
|
582
|
+
"default": "transactional",
|
|
583
|
+
"description": "Type of SMS"
|
|
584
|
+
},
|
|
585
|
+
"tag": {
|
|
586
|
+
"type": "string",
|
|
587
|
+
"description": "Tag for categorizing the SMS"
|
|
588
|
+
},
|
|
589
|
+
"webUrl": {
|
|
590
|
+
"type": "string",
|
|
591
|
+
"description": "Webhook URL for delivery reports"
|
|
592
|
+
}
|
|
593
|
+
},
|
|
594
|
+
"required": [
|
|
595
|
+
"sender",
|
|
596
|
+
"recipient",
|
|
597
|
+
"content"
|
|
598
|
+
]
|
|
599
|
+
}
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
"name": "get_email_events",
|
|
603
|
+
"description": "Get email event logs (deliveries, opens, clicks, bounces, etc.)",
|
|
604
|
+
"method": "GET",
|
|
605
|
+
"path": "/smtp/statistics/events",
|
|
606
|
+
"input_schema": {
|
|
607
|
+
"type": "object",
|
|
608
|
+
"properties": {
|
|
609
|
+
"limit": {
|
|
610
|
+
"type": "integer",
|
|
611
|
+
"default": 50,
|
|
612
|
+
"description": "Number of events to return"
|
|
613
|
+
},
|
|
614
|
+
"offset": {
|
|
615
|
+
"type": "integer",
|
|
616
|
+
"default": 0,
|
|
617
|
+
"description": "Index of first event"
|
|
618
|
+
},
|
|
619
|
+
"startDate": {
|
|
620
|
+
"type": "string",
|
|
621
|
+
"description": "Start date (YYYY-MM-DD)"
|
|
622
|
+
},
|
|
623
|
+
"endDate": {
|
|
624
|
+
"type": "string",
|
|
625
|
+
"description": "End date (YYYY-MM-DD)"
|
|
626
|
+
},
|
|
627
|
+
"email": {
|
|
628
|
+
"type": "string",
|
|
629
|
+
"description": "Filter by recipient email"
|
|
630
|
+
},
|
|
631
|
+
"event": {
|
|
632
|
+
"type": "string",
|
|
633
|
+
"enum": [
|
|
634
|
+
"bounces",
|
|
635
|
+
"hardBounces",
|
|
636
|
+
"softBounces",
|
|
637
|
+
"delivered",
|
|
638
|
+
"spam",
|
|
639
|
+
"requests",
|
|
640
|
+
"opened",
|
|
641
|
+
"clicks",
|
|
642
|
+
"invalid",
|
|
643
|
+
"deferred",
|
|
644
|
+
"blocked",
|
|
645
|
+
"unsubscribed",
|
|
646
|
+
"error"
|
|
647
|
+
],
|
|
648
|
+
"description": "Filter by event type"
|
|
649
|
+
},
|
|
650
|
+
"tags": {
|
|
651
|
+
"type": "string",
|
|
652
|
+
"description": "Filter by tag"
|
|
653
|
+
},
|
|
654
|
+
"messageId": {
|
|
655
|
+
"type": "string",
|
|
656
|
+
"description": "Filter by message ID"
|
|
657
|
+
},
|
|
658
|
+
"templateId": {
|
|
659
|
+
"type": "integer",
|
|
660
|
+
"description": "Filter by template ID"
|
|
661
|
+
},
|
|
662
|
+
"sort": {
|
|
663
|
+
"type": "string",
|
|
664
|
+
"enum": [
|
|
665
|
+
"asc",
|
|
666
|
+
"desc"
|
|
667
|
+
],
|
|
668
|
+
"default": "desc"
|
|
669
|
+
}
|
|
670
|
+
}
|
|
671
|
+
}
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
"name": "get_aggregated_report",
|
|
675
|
+
"description": "Get aggregated email statistics for a date range",
|
|
676
|
+
"method": "GET",
|
|
677
|
+
"path": "/smtp/statistics/aggregatedReport",
|
|
678
|
+
"input_schema": {
|
|
679
|
+
"type": "object",
|
|
680
|
+
"properties": {
|
|
681
|
+
"startDate": {
|
|
682
|
+
"type": "string",
|
|
683
|
+
"description": "Start date (YYYY-MM-DD)"
|
|
684
|
+
},
|
|
685
|
+
"endDate": {
|
|
686
|
+
"type": "string",
|
|
687
|
+
"description": "End date (YYYY-MM-DD)"
|
|
688
|
+
},
|
|
689
|
+
"days": {
|
|
690
|
+
"type": "integer",
|
|
691
|
+
"description": "Number of days (alternative to date range)"
|
|
692
|
+
},
|
|
693
|
+
"tag": {
|
|
694
|
+
"type": "string",
|
|
695
|
+
"description": "Filter by tag"
|
|
696
|
+
}
|
|
697
|
+
}
|
|
698
|
+
}
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"name": "get_campaigns",
|
|
702
|
+
"description": "Get all email campaigns",
|
|
703
|
+
"method": "GET",
|
|
704
|
+
"path": "/emailCampaigns",
|
|
705
|
+
"input_schema": {
|
|
706
|
+
"type": "object",
|
|
707
|
+
"properties": {
|
|
708
|
+
"type": {
|
|
709
|
+
"type": "string",
|
|
710
|
+
"enum": [
|
|
711
|
+
"classic",
|
|
712
|
+
"trigger"
|
|
713
|
+
],
|
|
714
|
+
"default": "classic",
|
|
715
|
+
"description": "Type of campaigns"
|
|
716
|
+
},
|
|
717
|
+
"status": {
|
|
718
|
+
"type": "string",
|
|
719
|
+
"enum": [
|
|
720
|
+
"suspended",
|
|
721
|
+
"archive",
|
|
722
|
+
"sent",
|
|
723
|
+
"queued",
|
|
724
|
+
"draft",
|
|
725
|
+
"inProcess"
|
|
726
|
+
],
|
|
727
|
+
"description": "Filter by status"
|
|
728
|
+
},
|
|
729
|
+
"limit": {
|
|
730
|
+
"type": "integer",
|
|
731
|
+
"default": 50,
|
|
732
|
+
"description": "Number of campaigns to return"
|
|
733
|
+
},
|
|
734
|
+
"offset": {
|
|
735
|
+
"type": "integer",
|
|
736
|
+
"default": 0,
|
|
737
|
+
"description": "Index of first campaign"
|
|
738
|
+
},
|
|
739
|
+
"sort": {
|
|
740
|
+
"type": "string",
|
|
741
|
+
"enum": [
|
|
742
|
+
"asc",
|
|
743
|
+
"desc"
|
|
744
|
+
],
|
|
745
|
+
"default": "desc"
|
|
746
|
+
}
|
|
747
|
+
}
|
|
748
|
+
}
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
"name": "get_campaign",
|
|
752
|
+
"description": "Get details of a specific email campaign",
|
|
753
|
+
"method": "GET",
|
|
754
|
+
"path": "/emailCampaigns/%7B%7BcampaignId%7D%7D",
|
|
755
|
+
"input_schema": {
|
|
756
|
+
"type": "object",
|
|
757
|
+
"properties": {
|
|
758
|
+
"campaignId": {
|
|
759
|
+
"type": "integer",
|
|
760
|
+
"description": "Campaign ID"
|
|
761
|
+
}
|
|
762
|
+
},
|
|
763
|
+
"required": [
|
|
764
|
+
"campaignId"
|
|
765
|
+
]
|
|
766
|
+
}
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
"name": "create_campaign",
|
|
770
|
+
"description": "Create a new email campaign",
|
|
771
|
+
"method": "POST",
|
|
772
|
+
"path": "/emailCampaigns",
|
|
773
|
+
"input_schema": {
|
|
774
|
+
"type": "object",
|
|
775
|
+
"properties": {
|
|
776
|
+
"name": {
|
|
777
|
+
"type": "string",
|
|
778
|
+
"description": "Campaign name"
|
|
779
|
+
},
|
|
780
|
+
"sender": {
|
|
781
|
+
"type": "object",
|
|
782
|
+
"description": "Sender information",
|
|
783
|
+
"properties": {
|
|
784
|
+
"name": {
|
|
785
|
+
"type": "string"
|
|
786
|
+
},
|
|
787
|
+
"email": {
|
|
788
|
+
"type": "string"
|
|
789
|
+
}
|
|
790
|
+
},
|
|
791
|
+
"required": [
|
|
792
|
+
"email"
|
|
793
|
+
]
|
|
794
|
+
},
|
|
795
|
+
"subject": {
|
|
796
|
+
"type": "string",
|
|
797
|
+
"description": "Email subject"
|
|
798
|
+
},
|
|
799
|
+
"htmlContent": {
|
|
800
|
+
"type": "string",
|
|
801
|
+
"description": "HTML content (use this OR templateId)"
|
|
802
|
+
},
|
|
803
|
+
"templateId": {
|
|
804
|
+
"type": "integer",
|
|
805
|
+
"description": "Template ID to use (use this OR htmlContent)"
|
|
806
|
+
},
|
|
807
|
+
"recipients": {
|
|
808
|
+
"type": "object",
|
|
809
|
+
"description": "Recipients configuration",
|
|
810
|
+
"properties": {
|
|
811
|
+
"listIds": {
|
|
812
|
+
"type": "array",
|
|
813
|
+
"items": {
|
|
814
|
+
"type": "integer"
|
|
815
|
+
},
|
|
816
|
+
"description": "List IDs to send to"
|
|
817
|
+
},
|
|
818
|
+
"exclusionListIds": {
|
|
819
|
+
"type": "array",
|
|
820
|
+
"items": {
|
|
821
|
+
"type": "integer"
|
|
822
|
+
},
|
|
823
|
+
"description": "List IDs to exclude"
|
|
824
|
+
}
|
|
825
|
+
}
|
|
826
|
+
},
|
|
827
|
+
"replyTo": {
|
|
828
|
+
"type": "string",
|
|
829
|
+
"description": "Reply-to email"
|
|
830
|
+
},
|
|
831
|
+
"toField": {
|
|
832
|
+
"type": "string",
|
|
833
|
+
"description": "To field personalization"
|
|
834
|
+
},
|
|
835
|
+
"tag": {
|
|
836
|
+
"type": "string",
|
|
837
|
+
"description": "Campaign tag"
|
|
838
|
+
},
|
|
839
|
+
"params": {
|
|
840
|
+
"type": "object",
|
|
841
|
+
"description": "Template parameters"
|
|
842
|
+
}
|
|
843
|
+
},
|
|
844
|
+
"required": [
|
|
845
|
+
"name",
|
|
846
|
+
"sender",
|
|
847
|
+
"subject",
|
|
848
|
+
"recipients"
|
|
849
|
+
]
|
|
850
|
+
}
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"name": "update_campaign",
|
|
854
|
+
"description": "Update an existing email campaign (only draft campaigns can be updated)",
|
|
855
|
+
"method": "PUT",
|
|
856
|
+
"path": "/emailCampaigns/%7B%7BcampaignId%7D%7D",
|
|
857
|
+
"input_schema": {
|
|
858
|
+
"type": "object",
|
|
859
|
+
"properties": {
|
|
860
|
+
"campaignId": {
|
|
861
|
+
"type": "integer",
|
|
862
|
+
"description": "Campaign ID to update"
|
|
863
|
+
},
|
|
864
|
+
"name": {
|
|
865
|
+
"type": "string",
|
|
866
|
+
"description": "New campaign name"
|
|
867
|
+
},
|
|
868
|
+
"sender": {
|
|
869
|
+
"type": "object",
|
|
870
|
+
"description": "Sender information"
|
|
871
|
+
},
|
|
872
|
+
"subject": {
|
|
873
|
+
"type": "string",
|
|
874
|
+
"description": "New subject"
|
|
875
|
+
},
|
|
876
|
+
"htmlContent": {
|
|
877
|
+
"type": "string",
|
|
878
|
+
"description": "New HTML content"
|
|
879
|
+
},
|
|
880
|
+
"recipients": {
|
|
881
|
+
"type": "object",
|
|
882
|
+
"description": "Recipients configuration"
|
|
883
|
+
},
|
|
884
|
+
"replyTo": {
|
|
885
|
+
"type": "string",
|
|
886
|
+
"description": "Reply-to email"
|
|
887
|
+
},
|
|
888
|
+
"tag": {
|
|
889
|
+
"type": "string",
|
|
890
|
+
"description": "Campaign tag"
|
|
891
|
+
}
|
|
892
|
+
},
|
|
893
|
+
"required": [
|
|
894
|
+
"campaignId"
|
|
895
|
+
]
|
|
896
|
+
}
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"name": "send_campaign_now",
|
|
900
|
+
"description": "Send an email campaign immediately",
|
|
901
|
+
"method": "POST",
|
|
902
|
+
"path": "/emailCampaigns/%7B%7BcampaignId%7D%7D/sendNow",
|
|
903
|
+
"input_schema": {
|
|
904
|
+
"type": "object",
|
|
905
|
+
"properties": {
|
|
906
|
+
"campaignId": {
|
|
907
|
+
"type": "integer",
|
|
908
|
+
"description": "Campaign ID to send"
|
|
909
|
+
}
|
|
910
|
+
},
|
|
911
|
+
"required": [
|
|
912
|
+
"campaignId"
|
|
913
|
+
]
|
|
914
|
+
}
|
|
915
|
+
},
|
|
916
|
+
{
|
|
917
|
+
"name": "send_test_email",
|
|
918
|
+
"description": "Send a test email for a campaign before launching",
|
|
919
|
+
"method": "POST",
|
|
920
|
+
"path": "/emailCampaigns/%7B%7BcampaignId%7D%7D/sendTest",
|
|
921
|
+
"input_schema": {
|
|
922
|
+
"type": "object",
|
|
923
|
+
"properties": {
|
|
924
|
+
"campaignId": {
|
|
925
|
+
"type": "integer",
|
|
926
|
+
"description": "Campaign ID"
|
|
927
|
+
},
|
|
928
|
+
"emailTo": {
|
|
929
|
+
"type": "array",
|
|
930
|
+
"items": {
|
|
931
|
+
"type": "string"
|
|
932
|
+
},
|
|
933
|
+
"description": "Email addresses to send test to"
|
|
934
|
+
}
|
|
935
|
+
},
|
|
936
|
+
"required": [
|
|
937
|
+
"campaignId",
|
|
938
|
+
"emailTo"
|
|
939
|
+
]
|
|
940
|
+
}
|
|
941
|
+
},
|
|
942
|
+
{
|
|
943
|
+
"name": "schedule_campaign",
|
|
944
|
+
"description": "Schedule an email campaign for a specific date and time",
|
|
945
|
+
"method": "POST",
|
|
946
|
+
"path": "/emailCampaigns/%7B%7BcampaignId%7D%7D/schedule",
|
|
947
|
+
"input_schema": {
|
|
948
|
+
"type": "object",
|
|
949
|
+
"properties": {
|
|
950
|
+
"campaignId": {
|
|
951
|
+
"type": "integer",
|
|
952
|
+
"description": "Campaign ID"
|
|
953
|
+
},
|
|
954
|
+
"scheduledAt": {
|
|
955
|
+
"type": "string",
|
|
956
|
+
"description": "Scheduled date and time in ISO 8601 format (e.g., 2024-01-15T10:00:00.000Z)"
|
|
957
|
+
}
|
|
958
|
+
},
|
|
959
|
+
"required": [
|
|
960
|
+
"campaignId",
|
|
961
|
+
"scheduledAt"
|
|
962
|
+
]
|
|
963
|
+
}
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
"name": "get_campaign_stats",
|
|
967
|
+
"description": "Get detailed statistics for an email campaign",
|
|
968
|
+
"method": "GET",
|
|
969
|
+
"path": "/emailCampaigns/%7B%7BcampaignId%7D%7D",
|
|
970
|
+
"input_schema": {
|
|
971
|
+
"type": "object",
|
|
972
|
+
"properties": {
|
|
973
|
+
"campaignId": {
|
|
974
|
+
"type": "integer",
|
|
975
|
+
"description": "Campaign ID"
|
|
976
|
+
}
|
|
977
|
+
},
|
|
978
|
+
"required": [
|
|
979
|
+
"campaignId"
|
|
980
|
+
]
|
|
981
|
+
}
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"name": "get_senders",
|
|
985
|
+
"description": "Get all validated sender identities",
|
|
986
|
+
"method": "GET",
|
|
987
|
+
"path": "/senders",
|
|
988
|
+
"input_schema": {
|
|
989
|
+
"type": "object",
|
|
990
|
+
"properties": {
|
|
991
|
+
"ip": {
|
|
992
|
+
"type": "string",
|
|
993
|
+
"description": "Filter by dedicated IP (optional)"
|
|
994
|
+
},
|
|
995
|
+
"domain": {
|
|
996
|
+
"type": "string",
|
|
997
|
+
"description": "Filter by domain (optional)"
|
|
998
|
+
}
|
|
999
|
+
}
|
|
1000
|
+
}
|
|
1001
|
+
},
|
|
1002
|
+
{
|
|
1003
|
+
"name": "create_sender",
|
|
1004
|
+
"description": "Create a new sender identity (requires email verification)",
|
|
1005
|
+
"method": "POST",
|
|
1006
|
+
"path": "/senders",
|
|
1007
|
+
"input_schema": {
|
|
1008
|
+
"type": "object",
|
|
1009
|
+
"properties": {
|
|
1010
|
+
"name": {
|
|
1011
|
+
"type": "string",
|
|
1012
|
+
"description": "Sender name"
|
|
1013
|
+
},
|
|
1014
|
+
"email": {
|
|
1015
|
+
"type": "string",
|
|
1016
|
+
"description": "Sender email address"
|
|
1017
|
+
}
|
|
1018
|
+
},
|
|
1019
|
+
"required": [
|
|
1020
|
+
"name",
|
|
1021
|
+
"email"
|
|
1022
|
+
]
|
|
1023
|
+
}
|
|
1024
|
+
},
|
|
1025
|
+
{
|
|
1026
|
+
"name": "delete_sender",
|
|
1027
|
+
"description": "Delete a sender identity",
|
|
1028
|
+
"method": "DELETE",
|
|
1029
|
+
"path": "/senders/%7B%7BsenderId%7D%7D",
|
|
1030
|
+
"input_schema": {
|
|
1031
|
+
"type": "object",
|
|
1032
|
+
"properties": {
|
|
1033
|
+
"senderId": {
|
|
1034
|
+
"type": "integer",
|
|
1035
|
+
"description": "Sender ID to delete"
|
|
1036
|
+
}
|
|
1037
|
+
},
|
|
1038
|
+
"required": [
|
|
1039
|
+
"senderId"
|
|
1040
|
+
]
|
|
1041
|
+
}
|
|
1042
|
+
},
|
|
1043
|
+
{
|
|
1044
|
+
"name": "create_webhook",
|
|
1045
|
+
"description": "Create a webhook to receive real-time email event notifications",
|
|
1046
|
+
"method": "POST",
|
|
1047
|
+
"path": "/webhooks",
|
|
1048
|
+
"input_schema": {
|
|
1049
|
+
"type": "object",
|
|
1050
|
+
"properties": {
|
|
1051
|
+
"url": {
|
|
1052
|
+
"type": "string",
|
|
1053
|
+
"description": "Webhook URL to receive events"
|
|
1054
|
+
},
|
|
1055
|
+
"description": {
|
|
1056
|
+
"type": "string",
|
|
1057
|
+
"description": "Description of the webhook"
|
|
1058
|
+
},
|
|
1059
|
+
"events": {
|
|
1060
|
+
"type": "array",
|
|
1061
|
+
"items": {
|
|
1062
|
+
"type": "string",
|
|
1063
|
+
"enum": [
|
|
1064
|
+
"sent",
|
|
1065
|
+
"hardBounce",
|
|
1066
|
+
"softBounce",
|
|
1067
|
+
"blocked",
|
|
1068
|
+
"spam",
|
|
1069
|
+
"delivered",
|
|
1070
|
+
"request",
|
|
1071
|
+
"click",
|
|
1072
|
+
"invalid",
|
|
1073
|
+
"deferred",
|
|
1074
|
+
"opened",
|
|
1075
|
+
"uniqueOpened",
|
|
1076
|
+
"unsubscribed",
|
|
1077
|
+
"listAddition",
|
|
1078
|
+
"contactUpdated",
|
|
1079
|
+
"contactDeleted"
|
|
1080
|
+
]
|
|
1081
|
+
},
|
|
1082
|
+
"description": "Events to subscribe to"
|
|
1083
|
+
},
|
|
1084
|
+
"type": {
|
|
1085
|
+
"type": "string",
|
|
1086
|
+
"enum": [
|
|
1087
|
+
"transactional",
|
|
1088
|
+
"marketing",
|
|
1089
|
+
"inbound"
|
|
1090
|
+
],
|
|
1091
|
+
"default": "transactional",
|
|
1092
|
+
"description": "Type of emails to monitor"
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"required": [
|
|
1096
|
+
"url",
|
|
1097
|
+
"events"
|
|
1098
|
+
]
|
|
1099
|
+
}
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"name": "get_webhooks",
|
|
1103
|
+
"description": "Get all webhooks",
|
|
1104
|
+
"method": "GET",
|
|
1105
|
+
"path": "/webhooks",
|
|
1106
|
+
"input_schema": {
|
|
1107
|
+
"type": "object",
|
|
1108
|
+
"properties": {
|
|
1109
|
+
"type": {
|
|
1110
|
+
"type": "string",
|
|
1111
|
+
"enum": [
|
|
1112
|
+
"transactional",
|
|
1113
|
+
"marketing",
|
|
1114
|
+
"inbound"
|
|
1115
|
+
],
|
|
1116
|
+
"default": "transactional",
|
|
1117
|
+
"description": "Filter by webhook type"
|
|
1118
|
+
},
|
|
1119
|
+
"sort": {
|
|
1120
|
+
"type": "string",
|
|
1121
|
+
"enum": [
|
|
1122
|
+
"asc",
|
|
1123
|
+
"desc"
|
|
1124
|
+
],
|
|
1125
|
+
"default": "desc"
|
|
1126
|
+
}
|
|
1127
|
+
}
|
|
1128
|
+
}
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"name": "delete_webhook",
|
|
1132
|
+
"description": "Delete a webhook",
|
|
1133
|
+
"method": "DELETE",
|
|
1134
|
+
"path": "/webhooks/%7B%7BwebhookId%7D%7D",
|
|
1135
|
+
"input_schema": {
|
|
1136
|
+
"type": "object",
|
|
1137
|
+
"properties": {
|
|
1138
|
+
"webhookId": {
|
|
1139
|
+
"type": "integer",
|
|
1140
|
+
"description": "Webhook ID to delete"
|
|
1141
|
+
}
|
|
1142
|
+
},
|
|
1143
|
+
"required": [
|
|
1144
|
+
"webhookId"
|
|
1145
|
+
]
|
|
1146
|
+
}
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"name": "get_account",
|
|
1150
|
+
"description": "Get Brevo account information and usage",
|
|
1151
|
+
"method": "GET",
|
|
1152
|
+
"path": "/account",
|
|
1153
|
+
"input_schema": {
|
|
1154
|
+
"type": "object",
|
|
1155
|
+
"properties": {}
|
|
1156
|
+
}
|
|
1157
|
+
},
|
|
1158
|
+
{
|
|
1159
|
+
"name": "import_contacts",
|
|
1160
|
+
"description": "Import contacts from a list of emails with optional attributes",
|
|
1161
|
+
"method": "POST",
|
|
1162
|
+
"path": "/contacts/import",
|
|
1163
|
+
"input_schema": {
|
|
1164
|
+
"type": "object",
|
|
1165
|
+
"properties": {
|
|
1166
|
+
"listIds": {
|
|
1167
|
+
"type": "array",
|
|
1168
|
+
"items": {
|
|
1169
|
+
"type": "integer"
|
|
1170
|
+
},
|
|
1171
|
+
"description": "List IDs to add contacts to"
|
|
1172
|
+
},
|
|
1173
|
+
"jsonBody": {
|
|
1174
|
+
"type": "array",
|
|
1175
|
+
"description": "Array of contact objects with email and attributes",
|
|
1176
|
+
"items": {
|
|
1177
|
+
"type": "object",
|
|
1178
|
+
"properties": {
|
|
1179
|
+
"email": {
|
|
1180
|
+
"type": "string"
|
|
1181
|
+
},
|
|
1182
|
+
"attributes": {
|
|
1183
|
+
"type": "object"
|
|
1184
|
+
}
|
|
1185
|
+
},
|
|
1186
|
+
"required": [
|
|
1187
|
+
"email"
|
|
1188
|
+
]
|
|
1189
|
+
}
|
|
1190
|
+
},
|
|
1191
|
+
"updateExistingContacts": {
|
|
1192
|
+
"type": "boolean",
|
|
1193
|
+
"default": true,
|
|
1194
|
+
"description": "Update contacts if they already exist"
|
|
1195
|
+
},
|
|
1196
|
+
"emptyContactsAttributes": {
|
|
1197
|
+
"type": "boolean",
|
|
1198
|
+
"default": false,
|
|
1199
|
+
"description": "Clear attributes not in import"
|
|
1200
|
+
}
|
|
1201
|
+
},
|
|
1202
|
+
"required": [
|
|
1203
|
+
"listIds",
|
|
1204
|
+
"jsonBody"
|
|
1205
|
+
]
|
|
1206
|
+
}
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"name": "get_folders",
|
|
1210
|
+
"description": "Get all contact list folders",
|
|
1211
|
+
"method": "GET",
|
|
1212
|
+
"path": "/contacts/folders",
|
|
1213
|
+
"input_schema": {
|
|
1214
|
+
"type": "object",
|
|
1215
|
+
"properties": {
|
|
1216
|
+
"limit": {
|
|
1217
|
+
"type": "integer",
|
|
1218
|
+
"default": 10,
|
|
1219
|
+
"description": "Number of folders to return"
|
|
1220
|
+
},
|
|
1221
|
+
"offset": {
|
|
1222
|
+
"type": "integer",
|
|
1223
|
+
"default": 0,
|
|
1224
|
+
"description": "Index of first folder"
|
|
1225
|
+
},
|
|
1226
|
+
"sort": {
|
|
1227
|
+
"type": "string",
|
|
1228
|
+
"enum": [
|
|
1229
|
+
"asc",
|
|
1230
|
+
"desc"
|
|
1231
|
+
],
|
|
1232
|
+
"default": "desc"
|
|
1233
|
+
}
|
|
1234
|
+
}
|
|
1235
|
+
}
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
"name": "create_folder",
|
|
1239
|
+
"description": "Create a folder to organize contact lists",
|
|
1240
|
+
"method": "POST",
|
|
1241
|
+
"path": "/contacts/folders",
|
|
1242
|
+
"input_schema": {
|
|
1243
|
+
"type": "object",
|
|
1244
|
+
"properties": {
|
|
1245
|
+
"name": {
|
|
1246
|
+
"type": "string",
|
|
1247
|
+
"description": "Folder name"
|
|
1248
|
+
}
|
|
1249
|
+
},
|
|
1250
|
+
"required": [
|
|
1251
|
+
"name"
|
|
1252
|
+
]
|
|
1253
|
+
}
|
|
1254
|
+
},
|
|
1255
|
+
{
|
|
1256
|
+
"name": "list_attributes",
|
|
1257
|
+
"description": "Get all contact attributes (fields) defined in your Brevo account. Attributes must exist before they can be used on contacts.",
|
|
1258
|
+
"method": "GET",
|
|
1259
|
+
"path": "/contacts/attributes",
|
|
1260
|
+
"input_schema": {
|
|
1261
|
+
"type": "object",
|
|
1262
|
+
"properties": {}
|
|
1263
|
+
}
|
|
1264
|
+
},
|
|
1265
|
+
{
|
|
1266
|
+
"name": "create_attribute",
|
|
1267
|
+
"description": "Create a new contact attribute (field) definition. You must create an attribute before you can use it on contacts. Categories: normal (standard fields), transactional, category (enumerated values), calculated, global.",
|
|
1268
|
+
"method": "POST",
|
|
1269
|
+
"path": "/contacts/attributes/%7B%7BattributeCategory%7D%7D/%7B%7BattributeName%7D%7D",
|
|
1270
|
+
"input_schema": {
|
|
1271
|
+
"type": "object",
|
|
1272
|
+
"properties": {
|
|
1273
|
+
"attributeCategory": {
|
|
1274
|
+
"type": "string",
|
|
1275
|
+
"enum": [
|
|
1276
|
+
"normal",
|
|
1277
|
+
"transactional",
|
|
1278
|
+
"category",
|
|
1279
|
+
"calculated",
|
|
1280
|
+
"global"
|
|
1281
|
+
],
|
|
1282
|
+
"description": "Category of the attribute (required)"
|
|
1283
|
+
},
|
|
1284
|
+
"attributeName": {
|
|
1285
|
+
"type": "string",
|
|
1286
|
+
"description": "Name of the attribute in UPPERCASE (required, e.g., FIRSTNAME, COMPANY)"
|
|
1287
|
+
},
|
|
1288
|
+
"type": {
|
|
1289
|
+
"type": "string",
|
|
1290
|
+
"enum": [
|
|
1291
|
+
"text",
|
|
1292
|
+
"date",
|
|
1293
|
+
"float",
|
|
1294
|
+
"boolean",
|
|
1295
|
+
"id",
|
|
1296
|
+
"category"
|
|
1297
|
+
],
|
|
1298
|
+
"description": "Type of the attribute (for normal/category/transactional)"
|
|
1299
|
+
},
|
|
1300
|
+
"value": {
|
|
1301
|
+
"type": "string",
|
|
1302
|
+
"description": "Value formula (for calculated/global attributes)"
|
|
1303
|
+
},
|
|
1304
|
+
"enumeration": {
|
|
1305
|
+
"type": "array",
|
|
1306
|
+
"description": "List of values for category attributes, e.g., [{\"value\":1,\"label\":\"Male\"},{\"value\":2,\"label\":\"Female\"}]",
|
|
1307
|
+
"items": {
|
|
1308
|
+
"type": "object",
|
|
1309
|
+
"properties": {
|
|
1310
|
+
"value": {
|
|
1311
|
+
"type": "integer"
|
|
1312
|
+
},
|
|
1313
|
+
"label": {
|
|
1314
|
+
"type": "string"
|
|
1315
|
+
}
|
|
1316
|
+
}
|
|
1317
|
+
}
|
|
1318
|
+
}
|
|
1319
|
+
},
|
|
1320
|
+
"required": [
|
|
1321
|
+
"attributeCategory",
|
|
1322
|
+
"attributeName"
|
|
1323
|
+
]
|
|
1324
|
+
}
|
|
1325
|
+
},
|
|
1326
|
+
{
|
|
1327
|
+
"name": "update_attribute",
|
|
1328
|
+
"description": "Update an existing contact attribute definition. Used to modify enumeration values for category attributes or formulas for calculated attributes.",
|
|
1329
|
+
"method": "PUT",
|
|
1330
|
+
"path": "/contacts/attributes/%7B%7BattributeCategory%7D%7D/%7B%7BattributeName%7D%7D",
|
|
1331
|
+
"input_schema": {
|
|
1332
|
+
"type": "object",
|
|
1333
|
+
"properties": {
|
|
1334
|
+
"attributeCategory": {
|
|
1335
|
+
"type": "string",
|
|
1336
|
+
"enum": [
|
|
1337
|
+
"normal",
|
|
1338
|
+
"category",
|
|
1339
|
+
"calculated",
|
|
1340
|
+
"global"
|
|
1341
|
+
],
|
|
1342
|
+
"description": "Category of the attribute (required)"
|
|
1343
|
+
},
|
|
1344
|
+
"attributeName": {
|
|
1345
|
+
"type": "string",
|
|
1346
|
+
"description": "Name of the existing attribute (required)"
|
|
1347
|
+
},
|
|
1348
|
+
"value": {
|
|
1349
|
+
"type": "string",
|
|
1350
|
+
"description": "New value formula (for calculated/global attributes)"
|
|
1351
|
+
},
|
|
1352
|
+
"enumeration": {
|
|
1353
|
+
"type": "array",
|
|
1354
|
+
"description": "Updated list of values for category attributes",
|
|
1355
|
+
"items": {
|
|
1356
|
+
"type": "object",
|
|
1357
|
+
"properties": {
|
|
1358
|
+
"value": {
|
|
1359
|
+
"type": "integer"
|
|
1360
|
+
},
|
|
1361
|
+
"label": {
|
|
1362
|
+
"type": "string"
|
|
1363
|
+
}
|
|
1364
|
+
}
|
|
1365
|
+
}
|
|
1366
|
+
}
|
|
1367
|
+
},
|
|
1368
|
+
"required": [
|
|
1369
|
+
"attributeCategory",
|
|
1370
|
+
"attributeName"
|
|
1371
|
+
]
|
|
1372
|
+
}
|
|
1373
|
+
},
|
|
1374
|
+
{
|
|
1375
|
+
"name": "delete_attribute",
|
|
1376
|
+
"description": "Delete a contact attribute definition. Warning: This removes the attribute from all contacts.",
|
|
1377
|
+
"method": "DELETE",
|
|
1378
|
+
"path": "/contacts/attributes/%7B%7BattributeCategory%7D%7D/%7B%7BattributeName%7D%7D",
|
|
1379
|
+
"input_schema": {
|
|
1380
|
+
"type": "object",
|
|
1381
|
+
"properties": {
|
|
1382
|
+
"attributeCategory": {
|
|
1383
|
+
"type": "string",
|
|
1384
|
+
"enum": [
|
|
1385
|
+
"normal",
|
|
1386
|
+
"transactional",
|
|
1387
|
+
"category",
|
|
1388
|
+
"calculated",
|
|
1389
|
+
"global"
|
|
1390
|
+
],
|
|
1391
|
+
"description": "Category of the attribute (required)"
|
|
1392
|
+
},
|
|
1393
|
+
"attributeName": {
|
|
1394
|
+
"type": "string",
|
|
1395
|
+
"description": "Name of the attribute to delete (required)"
|
|
1396
|
+
}
|
|
1397
|
+
},
|
|
1398
|
+
"required": [
|
|
1399
|
+
"attributeCategory",
|
|
1400
|
+
"attributeName"
|
|
1401
|
+
]
|
|
1402
|
+
}
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
"name": "get_list",
|
|
1406
|
+
"description": "Get details of a specific contact list including subscriber count",
|
|
1407
|
+
"method": "GET",
|
|
1408
|
+
"path": "/contacts/lists/%7B%7BlistId%7D%7D",
|
|
1409
|
+
"input_schema": {
|
|
1410
|
+
"type": "object",
|
|
1411
|
+
"properties": {
|
|
1412
|
+
"listId": {
|
|
1413
|
+
"type": "integer",
|
|
1414
|
+
"description": "ID of the list to retrieve"
|
|
1415
|
+
}
|
|
1416
|
+
},
|
|
1417
|
+
"required": [
|
|
1418
|
+
"listId"
|
|
1419
|
+
]
|
|
1420
|
+
}
|
|
1421
|
+
}
|
|
1422
|
+
]
|
|
1423
|
+
}
|