@inboxychat/sdk 0.0.0-stage → 0.2.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 +111 -2
- package/dist/api-route-inventory.generated.d.ts +2215 -0
- package/dist/api-route-inventory.generated.d.ts.map +1 -0
- package/dist/api-route-inventory.generated.js +2769 -0
- package/dist/api-route-inventory.generated.js.map +1 -0
- package/dist/capabilities.d.ts +24 -0
- package/dist/capabilities.d.ts.map +1 -0
- package/dist/capabilities.js +39 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/client.d.ts +80 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +314 -0
- package/dist/client.js.map +1 -0
- package/dist/credentials.d.ts +76 -0
- package/dist/credentials.d.ts.map +1 -0
- package/dist/credentials.js +323 -0
- package/dist/credentials.js.map +1 -0
- package/dist/errors.d.ts +48 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +78 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -0
- package/dist/index.js.map +1 -0
- package/dist/operations.d.ts +45 -0
- package/dist/operations.d.ts.map +1 -0
- package/dist/operations.js +467 -0
- package/dist/operations.js.map +1 -0
- package/dist/redact.d.ts +6 -0
- package/dist/redact.d.ts.map +1 -0
- package/dist/redact.js +25 -0
- package/dist/redact.js.map +1 -0
- package/dist/routes.d.ts +60 -0
- package/dist/routes.d.ts.map +1 -0
- package/dist/routes.js +24 -0
- package/dist/routes.js.map +1 -0
- package/dist/types.d.ts +295 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +69 -0
- package/dist/types.js.map +1 -0
- package/package.json +38 -3
|
@@ -0,0 +1,2769 @@
|
|
|
1
|
+
/** Generated discovery metadata only. These routes are NOT automatically executable. */
|
|
2
|
+
export const API_ROUTE_INVENTORY = [
|
|
3
|
+
{
|
|
4
|
+
"route": "POST /api/v1/whatsapp/messages/text",
|
|
5
|
+
"scope": "messages:send",
|
|
6
|
+
"summary": "Send a WhatsApp text message"
|
|
7
|
+
},
|
|
8
|
+
{
|
|
9
|
+
"route": "POST /api/v1/whatsapp/messages/template",
|
|
10
|
+
"scope": "messages:send",
|
|
11
|
+
"summary": "Send an approved WhatsApp template"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"route": "POST /api/v1/whatsapp/messages/media",
|
|
15
|
+
"scope": "messages:send",
|
|
16
|
+
"summary": "Send WhatsApp media (image, video, audio, document)"
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"route": "POST /api/v1/whatsapp/messages/buttons",
|
|
20
|
+
"scope": "messages:send",
|
|
21
|
+
"summary": "Send a WhatsApp reply-buttons message"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"route": "POST /api/v1/whatsapp/messages/list",
|
|
25
|
+
"scope": "messages:send",
|
|
26
|
+
"summary": "Send a WhatsApp list message"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"route": "POST /api/v1/inbox/conversations/:conversationId/messages",
|
|
30
|
+
"scope": "messages:send",
|
|
31
|
+
"summary": "Reply in a conversation on any channel"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"route": "POST /api/v1/whatsapp/messages/cta-url",
|
|
35
|
+
"scope": "messages:send",
|
|
36
|
+
"summary": "Send a WhatsApp call-to-action URL button"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"route": "POST /api/v1/whatsapp/messages/location-request",
|
|
40
|
+
"scope": "messages:send",
|
|
41
|
+
"summary": "Ask the customer to share their location"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"route": "POST /api/v1/whatsapp/messages/location",
|
|
45
|
+
"scope": "messages:send",
|
|
46
|
+
"summary": "Send a location pin"
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"route": "POST /api/v1/whatsapp/messages/contacts",
|
|
50
|
+
"scope": "messages:send",
|
|
51
|
+
"summary": "Send contact cards"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"route": "POST /api/v1/whatsapp/messages/contact",
|
|
55
|
+
"scope": "messages:send",
|
|
56
|
+
"summary": "Send one contact card"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"route": "POST /api/v1/whatsapp/messages/catalog",
|
|
60
|
+
"scope": "messages:send",
|
|
61
|
+
"summary": "Send the WhatsApp catalog"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"route": "POST /api/v1/whatsapp/messages/product",
|
|
65
|
+
"scope": "messages:send",
|
|
66
|
+
"summary": "Send one catalog product"
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"route": "POST /api/v1/whatsapp/messages/product-list",
|
|
70
|
+
"scope": "messages:send",
|
|
71
|
+
"summary": "Send a multi-product message"
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"route": "POST /api/v1/whatsapp/messages/catalog-card",
|
|
75
|
+
"scope": "messages:send",
|
|
76
|
+
"summary": "Send an Inboxy product or service card"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"route": "POST /api/v1/whatsapp/messages/:messageId/read",
|
|
80
|
+
"scope": "messages:send",
|
|
81
|
+
"summary": "Mark an inbound WhatsApp message as read"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"route": "POST /api/v1/whatsapp/media/upload",
|
|
85
|
+
"scope": "messages:send",
|
|
86
|
+
"summary": "Upload media to WhatsApp and get a media id for sends"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"route": "POST /api/v1/interactive-messages/send-saved",
|
|
90
|
+
"scope": "messages:send",
|
|
91
|
+
"summary": "Send a saved interactive message into a conversation"
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"route": "GET /api/v1/whatsapp/templates",
|
|
95
|
+
"scope": "templates:read",
|
|
96
|
+
"summary": "List WhatsApp templates"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"route": "GET /api/v1/whatsapp/templates/:templateId",
|
|
100
|
+
"scope": "templates:read",
|
|
101
|
+
"summary": "Get a WhatsApp template"
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"route": "GET /api/v1/whatsapp/templates/:templateName/usage",
|
|
105
|
+
"scope": "templates:read",
|
|
106
|
+
"summary": "Delivery ledger for a template"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"route": "POST /api/v1/whatsapp/templates",
|
|
110
|
+
"scope": "templates:write",
|
|
111
|
+
"summary": "Create a WhatsApp template and submit it to Meta for review"
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"route": "PUT /api/v1/whatsapp/templates/:templateId",
|
|
115
|
+
"scope": "templates:write",
|
|
116
|
+
"summary": "Edit a submitted template and send it back to Meta for review"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"route": "DELETE /api/v1/whatsapp/templates/:templateName",
|
|
120
|
+
"scope": "templates:write",
|
|
121
|
+
"summary": "Delete a WhatsApp template (all languages) from Meta and Inboxy"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"route": "POST /api/v1/whatsapp/templates/sync",
|
|
125
|
+
"scope": "templates:write",
|
|
126
|
+
"summary": "Sync templates and their approval status from Meta"
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"route": "POST /api/v1/whatsapp/media/upload-for-template",
|
|
130
|
+
"scope": "templates:write",
|
|
131
|
+
"summary": "Upload a template header file and get its media handle"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"route": "PATCH /api/v1/whatsapp/templates/:templateId/media",
|
|
135
|
+
"scope": "templates:write",
|
|
136
|
+
"summary": "Attach the media every send of this template uses"
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"route": "PATCH /api/v1/whatsapp/templates/:templateName/mapping",
|
|
140
|
+
"scope": "templates:write",
|
|
141
|
+
"summary": "Change where template variables get their values"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"route": "GET /api/v1/whatsapp/campaigns",
|
|
145
|
+
"scope": "campaigns:read",
|
|
146
|
+
"summary": "List WhatsApp campaigns"
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"route": "GET /api/v1/whatsapp/campaigns/:id",
|
|
150
|
+
"scope": "campaigns:read",
|
|
151
|
+
"summary": "Get a campaign"
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
"route": "GET /api/v1/whatsapp/campaigns/:id/details",
|
|
155
|
+
"scope": "campaigns:read",
|
|
156
|
+
"summary": "Get campaign details and counts"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"route": "GET /api/v1/whatsapp/campaigns/:id/recipients",
|
|
160
|
+
"scope": "campaigns:read",
|
|
161
|
+
"summary": "List campaign recipients"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"route": "GET /api/v1/whatsapp/campaigns/:id/analytics",
|
|
165
|
+
"scope": "campaigns:read",
|
|
166
|
+
"summary": "Get campaign link clicks"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"route": "GET /api/v1/whatsapp/campaigns/:id/timeseries",
|
|
170
|
+
"scope": "campaigns:read",
|
|
171
|
+
"summary": "Get deliveries over time"
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"route": "POST /api/v1/whatsapp/campaigns/preview",
|
|
175
|
+
"scope": "campaigns:read",
|
|
176
|
+
"summary": "Preview audience size and cost without creating"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"route": "POST /api/v1/whatsapp/campaigns",
|
|
180
|
+
"scope": "campaigns:write",
|
|
181
|
+
"summary": "Create a campaign"
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"route": "PUT /api/v1/whatsapp/campaigns/:id",
|
|
185
|
+
"scope": "campaigns:write",
|
|
186
|
+
"summary": "Update a draft or scheduled campaign"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"route": "DELETE /api/v1/whatsapp/campaigns/:id",
|
|
190
|
+
"scope": "campaigns:write",
|
|
191
|
+
"summary": "Delete a campaign"
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"route": "POST /api/v1/whatsapp/campaigns/import-audience",
|
|
195
|
+
"scope": "campaigns:write",
|
|
196
|
+
"summary": "Import an audience (matches or creates contacts)"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"route": "GET /api/v1/whatsapp/campaigns/:id/action-preview",
|
|
200
|
+
"scope": "campaigns:read",
|
|
201
|
+
"summary": "Preview exact campaign recipients, content, sender and timing"
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
"route": "POST /api/v1/whatsapp/campaigns/:id/approved-send",
|
|
205
|
+
"scope": "campaigns:write",
|
|
206
|
+
"summary": "Send the exact approved campaign snapshot"
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"route": "POST /api/v1/whatsapp/campaigns/:id/approved-schedule",
|
|
210
|
+
"scope": "campaigns:write",
|
|
211
|
+
"summary": "Schedule the exact approved campaign snapshot"
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"route": "POST /api/v1/whatsapp/campaigns/:id/approved-resume",
|
|
215
|
+
"scope": "campaigns:write",
|
|
216
|
+
"summary": "Resume the exact approved remaining audience"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"route": "POST /api/v1/whatsapp/campaigns/:id/run",
|
|
220
|
+
"scope": "campaigns:write",
|
|
221
|
+
"summary": "Start sending a campaign"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"route": "POST /api/v1/whatsapp/campaigns/:id/pause",
|
|
225
|
+
"scope": "campaigns:write",
|
|
226
|
+
"summary": "Pause a running campaign"
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"route": "POST /api/v1/whatsapp/campaigns/:id/resume",
|
|
230
|
+
"scope": "campaigns:write",
|
|
231
|
+
"summary": "Resume a paused campaign"
|
|
232
|
+
},
|
|
233
|
+
{
|
|
234
|
+
"route": "POST /api/v1/whatsapp/campaigns/:id/cancel",
|
|
235
|
+
"scope": "campaigns:write",
|
|
236
|
+
"summary": "Cancel a campaign"
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"route": "POST /api/v1/whatsapp/campaigns/:id/retry",
|
|
240
|
+
"scope": "campaigns:write",
|
|
241
|
+
"summary": "Retry failed recipients"
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"route": "GET /api/v1/scheduled-messages",
|
|
245
|
+
"scope": "messages:read",
|
|
246
|
+
"summary": "List scheduled messages"
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"route": "GET /api/v1/scheduled-messages/:id",
|
|
250
|
+
"scope": "messages:read",
|
|
251
|
+
"summary": "Get one scheduled message"
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"route": "POST /api/v1/scheduled-messages",
|
|
255
|
+
"scope": "messages:send",
|
|
256
|
+
"summary": "Schedule a message"
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"route": "PATCH /api/v1/scheduled-messages/:id",
|
|
260
|
+
"scope": "messages:send",
|
|
261
|
+
"summary": "Reschedule or edit a scheduled message"
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
"route": "POST /api/v1/scheduled-messages/:id/retry",
|
|
265
|
+
"scope": "messages:send",
|
|
266
|
+
"summary": "Retry a failed scheduled message"
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"route": "POST /api/v1/scheduled-messages/:id/cancel",
|
|
270
|
+
"scope": "messages:send",
|
|
271
|
+
"summary": "Cancel a scheduled message"
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"route": "POST /api/v1/scheduled-messages/:id/pause",
|
|
275
|
+
"scope": "messages:send",
|
|
276
|
+
"summary": "Pause a recurring message"
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"route": "POST /api/v1/scheduled-messages/:id/resume",
|
|
280
|
+
"scope": "messages:send",
|
|
281
|
+
"summary": "Resume a paused message"
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"route": "POST /api/v1/scheduled-messages/:id/send-now",
|
|
285
|
+
"scope": "messages:send",
|
|
286
|
+
"summary": "Send a scheduled message now"
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
"route": "DELETE /api/v1/scheduled-messages/:id",
|
|
290
|
+
"scope": "messages:send",
|
|
291
|
+
"summary": "Delete a scheduled message"
|
|
292
|
+
},
|
|
293
|
+
{
|
|
294
|
+
"route": "GET /api/v1/interactive-messages",
|
|
295
|
+
"scope": "library:read",
|
|
296
|
+
"summary": "List saved interactive messages"
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
"route": "GET /api/v1/interactive-messages/stats",
|
|
300
|
+
"scope": "library:read",
|
|
301
|
+
"summary": "Saved interactive message stats"
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"route": "GET /api/v1/interactive-messages/categories",
|
|
305
|
+
"scope": "library:read",
|
|
306
|
+
"summary": "List library categories"
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"route": "GET /api/v1/interactive-messages/:id",
|
|
310
|
+
"scope": "library:read",
|
|
311
|
+
"summary": "Get a saved interactive message"
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"route": "POST /api/v1/interactive-messages",
|
|
315
|
+
"scope": "library:write",
|
|
316
|
+
"summary": "Save an interactive message"
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"route": "PUT /api/v1/interactive-messages/:id",
|
|
320
|
+
"scope": "library:write",
|
|
321
|
+
"summary": "Update a saved interactive message"
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"route": "DELETE /api/v1/interactive-messages/:id",
|
|
325
|
+
"scope": "library:write",
|
|
326
|
+
"summary": "Delete a saved interactive message"
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"route": "POST /api/v1/interactive-messages/:id/duplicate",
|
|
330
|
+
"scope": "library:write",
|
|
331
|
+
"summary": "Duplicate a saved interactive message"
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
"route": "GET /api/v1/me/channels",
|
|
335
|
+
"scope": "channels:read",
|
|
336
|
+
"summary": "Connection status of every channel (WhatsApp, Instagram, Messenger, Telegram, website chat)"
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"route": "POST /api/v1/instagram/send",
|
|
340
|
+
"scope": "messages:send",
|
|
341
|
+
"summary": "Send an Instagram DM"
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"route": "POST /api/v1/instagram/send/buttons",
|
|
345
|
+
"scope": "messages:send",
|
|
346
|
+
"summary": "Send an Instagram DM with buttons"
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"route": "POST /api/v1/instagram/send/carousel",
|
|
350
|
+
"scope": "messages:send",
|
|
351
|
+
"summary": "Send an Instagram carousel"
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"route": "POST /api/v1/instagram/send/quick-replies",
|
|
355
|
+
"scope": "messages:send",
|
|
356
|
+
"summary": "Send Instagram quick replies"
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"route": "POST /api/v1/instagram/send/media-template",
|
|
360
|
+
"scope": "messages:send",
|
|
361
|
+
"summary": "Send an Instagram media template"
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
"route": "POST /api/v1/instagram/templates/:id/send",
|
|
365
|
+
"scope": "messages:send",
|
|
366
|
+
"summary": "Send a saved Instagram template"
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"route": "GET /api/v1/instagram/conversations/:conversationId/window",
|
|
370
|
+
"scope": "conversations:read",
|
|
371
|
+
"summary": "Check the Instagram messaging window"
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"route": "GET /api/v1/instagram/templates",
|
|
375
|
+
"scope": "templates:read",
|
|
376
|
+
"summary": "List saved Instagram templates"
|
|
377
|
+
},
|
|
378
|
+
{
|
|
379
|
+
"route": "GET /api/v1/instagram/templates/:id",
|
|
380
|
+
"scope": "templates:read",
|
|
381
|
+
"summary": "Get a saved Instagram template"
|
|
382
|
+
},
|
|
383
|
+
{
|
|
384
|
+
"route": "GET /api/v1/instagram/templates/:id/detail",
|
|
385
|
+
"scope": "templates:read",
|
|
386
|
+
"summary": "Get template detail and usage"
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"route": "POST /api/v1/instagram/templates",
|
|
390
|
+
"scope": "templates:write",
|
|
391
|
+
"summary": "Save an Instagram template"
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"route": "PUT /api/v1/instagram/templates/:id",
|
|
395
|
+
"scope": "templates:write",
|
|
396
|
+
"summary": "Update a saved Instagram template"
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"route": "DELETE /api/v1/instagram/templates/:id",
|
|
400
|
+
"scope": "templates:write",
|
|
401
|
+
"summary": "Delete a saved Instagram template"
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"route": "GET /api/v1/instagram/quick-replies",
|
|
405
|
+
"scope": "library:read",
|
|
406
|
+
"summary": "List Instagram quick replies"
|
|
407
|
+
},
|
|
408
|
+
{
|
|
409
|
+
"route": "GET /api/v1/instagram/quick-replies/categories",
|
|
410
|
+
"scope": "library:read",
|
|
411
|
+
"summary": "List quick reply categories"
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"route": "GET /api/v1/instagram/quick-replies/:id",
|
|
415
|
+
"scope": "library:read",
|
|
416
|
+
"summary": "Get an Instagram quick reply"
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
"route": "POST /api/v1/instagram/quick-replies",
|
|
420
|
+
"scope": "library:write",
|
|
421
|
+
"summary": "Create an Instagram quick reply"
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"route": "PUT /api/v1/instagram/quick-replies/:id",
|
|
425
|
+
"scope": "library:write",
|
|
426
|
+
"summary": "Update an Instagram quick reply"
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"route": "DELETE /api/v1/instagram/quick-replies/:id",
|
|
430
|
+
"scope": "library:write",
|
|
431
|
+
"summary": "Delete an Instagram quick reply"
|
|
432
|
+
},
|
|
433
|
+
{
|
|
434
|
+
"route": "GET /api/v1/instagram/interactive-messages",
|
|
435
|
+
"scope": "library:read",
|
|
436
|
+
"summary": "List Instagram interactive messages"
|
|
437
|
+
},
|
|
438
|
+
{
|
|
439
|
+
"route": "GET /api/v1/instagram/interactive-messages/:id",
|
|
440
|
+
"scope": "library:read",
|
|
441
|
+
"summary": "Get an Instagram interactive message"
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
"route": "POST /api/v1/instagram/interactive-messages",
|
|
445
|
+
"scope": "library:write",
|
|
446
|
+
"summary": "Save an Instagram interactive message"
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"route": "PUT /api/v1/instagram/interactive-messages/:id",
|
|
450
|
+
"scope": "library:write",
|
|
451
|
+
"summary": "Update an Instagram interactive message"
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
"route": "DELETE /api/v1/instagram/interactive-messages/:id",
|
|
455
|
+
"scope": "library:write",
|
|
456
|
+
"summary": "Delete an Instagram interactive message"
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"route": "GET /api/v1/instagram/campaigns",
|
|
460
|
+
"scope": "campaigns:read",
|
|
461
|
+
"summary": "List Instagram campaigns"
|
|
462
|
+
},
|
|
463
|
+
{
|
|
464
|
+
"route": "GET /api/v1/instagram/campaigns/:id",
|
|
465
|
+
"scope": "campaigns:read",
|
|
466
|
+
"summary": "Get an Instagram campaign"
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"route": "GET /api/v1/instagram/campaigns/:id/recipients",
|
|
470
|
+
"scope": "campaigns:read",
|
|
471
|
+
"summary": "List campaign recipients"
|
|
472
|
+
},
|
|
473
|
+
{
|
|
474
|
+
"route": "GET /api/v1/instagram/campaigns/:id/stats",
|
|
475
|
+
"scope": "campaigns:read",
|
|
476
|
+
"summary": "Campaign delivery stats"
|
|
477
|
+
},
|
|
478
|
+
{
|
|
479
|
+
"route": "POST /api/v1/instagram/campaigns",
|
|
480
|
+
"scope": "campaigns:write",
|
|
481
|
+
"summary": "Create an Instagram campaign"
|
|
482
|
+
},
|
|
483
|
+
{
|
|
484
|
+
"route": "PUT /api/v1/instagram/campaigns/:id",
|
|
485
|
+
"scope": "campaigns:write",
|
|
486
|
+
"summary": "Update an Instagram campaign"
|
|
487
|
+
},
|
|
488
|
+
{
|
|
489
|
+
"route": "DELETE /api/v1/instagram/campaigns/:id",
|
|
490
|
+
"scope": "campaigns:write",
|
|
491
|
+
"summary": "Delete an Instagram campaign"
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"route": "POST /api/v1/instagram/campaigns/:id/recipients",
|
|
495
|
+
"scope": "campaigns:write",
|
|
496
|
+
"summary": "Add campaign recipients"
|
|
497
|
+
},
|
|
498
|
+
{
|
|
499
|
+
"route": "POST /api/v1/instagram/campaigns/:id/run",
|
|
500
|
+
"scope": "campaigns:write",
|
|
501
|
+
"summary": "Start an Instagram campaign"
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"route": "POST /api/v1/instagram/campaigns/:id/pause",
|
|
505
|
+
"scope": "campaigns:write",
|
|
506
|
+
"summary": "Pause an Instagram campaign"
|
|
507
|
+
},
|
|
508
|
+
{
|
|
509
|
+
"route": "POST /api/v1/instagram/campaigns/:id/resume",
|
|
510
|
+
"scope": "campaigns:write",
|
|
511
|
+
"summary": "Resume an Instagram campaign"
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"route": "POST /api/v1/instagram/campaigns/:id/cancel",
|
|
515
|
+
"scope": "campaigns:write",
|
|
516
|
+
"summary": "Cancel an Instagram campaign"
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"route": "POST /api/v1/instagram/campaigns/:id/duplicate",
|
|
520
|
+
"scope": "campaigns:write",
|
|
521
|
+
"summary": "Duplicate an Instagram campaign"
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
"route": "GET /api/v1/instagram/comment-automations",
|
|
525
|
+
"scope": "automations:read",
|
|
526
|
+
"summary": "List comment-to-DM automations"
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"route": "GET /api/v1/instagram/comment-automations/:id",
|
|
530
|
+
"scope": "automations:read",
|
|
531
|
+
"summary": "Get a comment-to-DM automation"
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
"route": "GET /api/v1/instagram/comment-automations/posts",
|
|
535
|
+
"scope": "channels:read",
|
|
536
|
+
"summary": "List your Instagram posts"
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
"route": "GET /api/v1/instagram/comment-automations/posts/:mediaId/comments",
|
|
540
|
+
"scope": "channels:read",
|
|
541
|
+
"summary": "List comments on an Instagram post"
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
"route": "POST /api/v1/instagram/comment-automations",
|
|
545
|
+
"scope": "automations:write",
|
|
546
|
+
"summary": "Auto-reply to comments on a post (public reply and/or DM)"
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"route": "PUT /api/v1/instagram/comment-automations/:id",
|
|
550
|
+
"scope": "automations:write",
|
|
551
|
+
"summary": "Update a comment-to-DM automation"
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"route": "PATCH /api/v1/instagram/comment-automations/:id/toggle",
|
|
555
|
+
"scope": "automations:write",
|
|
556
|
+
"summary": "Turn a comment-to-DM automation on or off"
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"route": "DELETE /api/v1/instagram/comment-automations/:id",
|
|
560
|
+
"scope": "automations:write",
|
|
561
|
+
"summary": "Delete a comment-to-DM automation"
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"route": "GET /api/v1/instagram/ice-breakers",
|
|
565
|
+
"scope": "channels:read",
|
|
566
|
+
"summary": "List Instagram ice breakers"
|
|
567
|
+
},
|
|
568
|
+
{
|
|
569
|
+
"route": "POST /api/v1/instagram/ice-breakers",
|
|
570
|
+
"scope": "channels:write",
|
|
571
|
+
"summary": "Replace Instagram ice breakers"
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
"route": "POST /api/v1/instagram/ice-breakers/add",
|
|
575
|
+
"scope": "channels:write",
|
|
576
|
+
"summary": "Add an ice breaker"
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
"route": "POST /api/v1/instagram/ice-breakers/reorder",
|
|
580
|
+
"scope": "channels:write",
|
|
581
|
+
"summary": "Reorder ice breakers"
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"route": "PUT /api/v1/instagram/ice-breakers/:index",
|
|
585
|
+
"scope": "channels:write",
|
|
586
|
+
"summary": "Update an ice breaker"
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"route": "DELETE /api/v1/instagram/ice-breakers/:index",
|
|
590
|
+
"scope": "channels:write",
|
|
591
|
+
"summary": "Delete an ice breaker"
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"route": "DELETE /api/v1/instagram/ice-breakers",
|
|
595
|
+
"scope": "channels:write",
|
|
596
|
+
"summary": "Remove all ice breakers"
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"route": "GET /api/v1/instagram/story-mentions/config",
|
|
600
|
+
"scope": "automations:read",
|
|
601
|
+
"summary": "Story mention auto-reply settings"
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
"route": "PUT /api/v1/instagram/story-mentions/config",
|
|
605
|
+
"scope": "automations:write",
|
|
606
|
+
"summary": "Change story mention auto-reply settings"
|
|
607
|
+
},
|
|
608
|
+
{
|
|
609
|
+
"route": "POST /api/v1/instagram/story-mentions/responses",
|
|
610
|
+
"scope": "automations:write",
|
|
611
|
+
"summary": "Add a story mention reply"
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
"route": "PUT /api/v1/instagram/story-mentions/responses/:id",
|
|
615
|
+
"scope": "automations:write",
|
|
616
|
+
"summary": "Update a story mention reply"
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
"route": "DELETE /api/v1/instagram/story-mentions/responses/:id",
|
|
620
|
+
"scope": "automations:write",
|
|
621
|
+
"summary": "Delete a story mention reply"
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
"route": "GET /api/v1/instagram/story-mentions/stats",
|
|
625
|
+
"scope": "analytics:read",
|
|
626
|
+
"summary": "Story mention stats"
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
"route": "GET /api/v1/instagram/stats",
|
|
630
|
+
"scope": "analytics:read",
|
|
631
|
+
"summary": "Instagram message totals"
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"route": "GET /api/v1/instagram/top-performers",
|
|
635
|
+
"scope": "analytics:read",
|
|
636
|
+
"summary": "Top Instagram templates and replies"
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"route": "GET /api/v1/instagram/volume-timeline",
|
|
640
|
+
"scope": "analytics:read",
|
|
641
|
+
"summary": "Instagram message volume over time"
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
"route": "GET /api/v1/instagram/rate-limit",
|
|
645
|
+
"scope": "channels:read",
|
|
646
|
+
"summary": "Remaining Instagram send quota"
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"route": "POST /api/v1/messenger/send",
|
|
650
|
+
"scope": "messages:send",
|
|
651
|
+
"summary": "Send a Messenger message"
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
"route": "POST /api/v1/messenger/send/media",
|
|
655
|
+
"scope": "messages:send",
|
|
656
|
+
"summary": "Send Messenger media"
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"route": "POST /api/v1/messenger/send/buttons",
|
|
660
|
+
"scope": "messages:send",
|
|
661
|
+
"summary": "Send a Messenger button template"
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
"route": "POST /api/v1/messenger/send/carousel",
|
|
665
|
+
"scope": "messages:send",
|
|
666
|
+
"summary": "Send a Messenger carousel"
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"route": "POST /api/v1/messenger/send/quick-replies",
|
|
670
|
+
"scope": "messages:send",
|
|
671
|
+
"summary": "Send Messenger quick replies"
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
"route": "POST /api/v1/messenger/send/media-template",
|
|
675
|
+
"scope": "messages:send",
|
|
676
|
+
"summary": "Send a Messenger media template"
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"route": "POST /api/v1/messenger/send/receipt",
|
|
680
|
+
"scope": "messages:send",
|
|
681
|
+
"summary": "Send a Messenger order receipt"
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"route": "POST /api/v1/messenger/send/tag",
|
|
685
|
+
"scope": "messages:send",
|
|
686
|
+
"summary": "Send outside the 24-hour window with a message tag"
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"route": "POST /api/v1/messenger/templates/:id/send",
|
|
690
|
+
"scope": "messages:send",
|
|
691
|
+
"summary": "Send a saved Messenger template"
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
"route": "GET /api/v1/messenger/window/:conversationId",
|
|
695
|
+
"scope": "conversations:read",
|
|
696
|
+
"summary": "Check the Messenger messaging window"
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"route": "GET /api/v1/messenger/templates",
|
|
700
|
+
"scope": "templates:read",
|
|
701
|
+
"summary": "List saved Messenger templates"
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"route": "GET /api/v1/messenger/templates/:id",
|
|
705
|
+
"scope": "templates:read",
|
|
706
|
+
"summary": "Get a saved Messenger template"
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"route": "GET /api/v1/messenger/templates/:id/detail",
|
|
710
|
+
"scope": "templates:read",
|
|
711
|
+
"summary": "Get template detail and usage"
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"route": "POST /api/v1/messenger/templates",
|
|
715
|
+
"scope": "templates:write",
|
|
716
|
+
"summary": "Save a Messenger template"
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"route": "PUT /api/v1/messenger/templates/:id",
|
|
720
|
+
"scope": "templates:write",
|
|
721
|
+
"summary": "Update a saved Messenger template"
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"route": "DELETE /api/v1/messenger/templates/:id",
|
|
725
|
+
"scope": "templates:write",
|
|
726
|
+
"summary": "Delete a saved Messenger template"
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"route": "POST /api/v1/messenger/templates/:id/duplicate",
|
|
730
|
+
"scope": "templates:write",
|
|
731
|
+
"summary": "Duplicate a Messenger template"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"route": "GET /api/v1/messenger/quick-replies",
|
|
735
|
+
"scope": "library:read",
|
|
736
|
+
"summary": "List Messenger quick replies"
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"route": "GET /api/v1/messenger/quick-replies/categories",
|
|
740
|
+
"scope": "library:read",
|
|
741
|
+
"summary": "List quick reply categories"
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
"route": "GET /api/v1/messenger/quick-replies/:id",
|
|
745
|
+
"scope": "library:read",
|
|
746
|
+
"summary": "Get a Messenger quick reply"
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
"route": "POST /api/v1/messenger/quick-replies",
|
|
750
|
+
"scope": "library:write",
|
|
751
|
+
"summary": "Create a Messenger quick reply"
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"route": "PUT /api/v1/messenger/quick-replies/:id",
|
|
755
|
+
"scope": "library:write",
|
|
756
|
+
"summary": "Update a Messenger quick reply"
|
|
757
|
+
},
|
|
758
|
+
{
|
|
759
|
+
"route": "DELETE /api/v1/messenger/quick-replies/:id",
|
|
760
|
+
"scope": "library:write",
|
|
761
|
+
"summary": "Delete a Messenger quick reply"
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"route": "POST /api/v1/messenger/quick-replies/:id/duplicate",
|
|
765
|
+
"scope": "library:write",
|
|
766
|
+
"summary": "Duplicate a Messenger quick reply"
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
"route": "GET /api/v1/messenger/interactive-messages",
|
|
770
|
+
"scope": "library:read",
|
|
771
|
+
"summary": "List Messenger interactive messages"
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"route": "GET /api/v1/messenger/interactive-messages/:id",
|
|
775
|
+
"scope": "library:read",
|
|
776
|
+
"summary": "Get a Messenger interactive message"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"route": "POST /api/v1/messenger/interactive-messages",
|
|
780
|
+
"scope": "library:write",
|
|
781
|
+
"summary": "Save a Messenger interactive message"
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"route": "PUT /api/v1/messenger/interactive-messages/:id",
|
|
785
|
+
"scope": "library:write",
|
|
786
|
+
"summary": "Update a Messenger interactive message"
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"route": "DELETE /api/v1/messenger/interactive-messages/:id",
|
|
790
|
+
"scope": "library:write",
|
|
791
|
+
"summary": "Delete a Messenger interactive message"
|
|
792
|
+
},
|
|
793
|
+
{
|
|
794
|
+
"route": "GET /api/v1/messenger/campaigns",
|
|
795
|
+
"scope": "campaigns:read",
|
|
796
|
+
"summary": "List Messenger campaigns"
|
|
797
|
+
},
|
|
798
|
+
{
|
|
799
|
+
"route": "GET /api/v1/messenger/campaigns/:id",
|
|
800
|
+
"scope": "campaigns:read",
|
|
801
|
+
"summary": "Get a Messenger campaign"
|
|
802
|
+
},
|
|
803
|
+
{
|
|
804
|
+
"route": "GET /api/v1/messenger/campaigns/:id/recipients",
|
|
805
|
+
"scope": "campaigns:read",
|
|
806
|
+
"summary": "List campaign recipients"
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"route": "GET /api/v1/messenger/campaigns/:id/stats",
|
|
810
|
+
"scope": "campaigns:read",
|
|
811
|
+
"summary": "Campaign delivery stats"
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"route": "POST /api/v1/messenger/campaigns",
|
|
815
|
+
"scope": "campaigns:write",
|
|
816
|
+
"summary": "Create a Messenger campaign"
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"route": "PUT /api/v1/messenger/campaigns/:id",
|
|
820
|
+
"scope": "campaigns:write",
|
|
821
|
+
"summary": "Update a Messenger campaign"
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
"route": "DELETE /api/v1/messenger/campaigns/:id",
|
|
825
|
+
"scope": "campaigns:write",
|
|
826
|
+
"summary": "Delete a Messenger campaign"
|
|
827
|
+
},
|
|
828
|
+
{
|
|
829
|
+
"route": "POST /api/v1/messenger/campaigns/:id/recipients",
|
|
830
|
+
"scope": "campaigns:write",
|
|
831
|
+
"summary": "Add campaign recipients"
|
|
832
|
+
},
|
|
833
|
+
{
|
|
834
|
+
"route": "POST /api/v1/messenger/campaigns/:id/run",
|
|
835
|
+
"scope": "campaigns:write",
|
|
836
|
+
"summary": "Start a Messenger campaign"
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"route": "POST /api/v1/messenger/campaigns/:id/pause",
|
|
840
|
+
"scope": "campaigns:write",
|
|
841
|
+
"summary": "Pause a Messenger campaign"
|
|
842
|
+
},
|
|
843
|
+
{
|
|
844
|
+
"route": "POST /api/v1/messenger/campaigns/:id/resume",
|
|
845
|
+
"scope": "campaigns:write",
|
|
846
|
+
"summary": "Resume a Messenger campaign"
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"route": "POST /api/v1/messenger/campaigns/:id/cancel",
|
|
850
|
+
"scope": "campaigns:write",
|
|
851
|
+
"summary": "Cancel a Messenger campaign"
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"route": "POST /api/v1/messenger/campaigns/:id/duplicate",
|
|
855
|
+
"scope": "campaigns:write",
|
|
856
|
+
"summary": "Duplicate a Messenger campaign"
|
|
857
|
+
},
|
|
858
|
+
{
|
|
859
|
+
"route": "GET /api/v1/messenger/comment-automations",
|
|
860
|
+
"scope": "automations:read",
|
|
861
|
+
"summary": "List comment-to-DM automations"
|
|
862
|
+
},
|
|
863
|
+
{
|
|
864
|
+
"route": "GET /api/v1/messenger/comment-automations/:id",
|
|
865
|
+
"scope": "automations:read",
|
|
866
|
+
"summary": "Get a comment-to-DM automation"
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"route": "GET /api/v1/messenger/comment-automations/posts",
|
|
870
|
+
"scope": "channels:read",
|
|
871
|
+
"summary": "List your Facebook Page posts"
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"route": "GET /api/v1/messenger/comment-automations/posts/:mediaId/comments",
|
|
875
|
+
"scope": "channels:read",
|
|
876
|
+
"summary": "List comments on a Page post"
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"route": "POST /api/v1/messenger/comment-automations",
|
|
880
|
+
"scope": "automations:write",
|
|
881
|
+
"summary": "Auto-reply to comments on a Page post (public reply and/or DM)"
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"route": "PUT /api/v1/messenger/comment-automations/:id",
|
|
885
|
+
"scope": "automations:write",
|
|
886
|
+
"summary": "Update a comment-to-DM automation"
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"route": "PATCH /api/v1/messenger/comment-automations/:id/toggle",
|
|
890
|
+
"scope": "automations:write",
|
|
891
|
+
"summary": "Turn a comment-to-DM automation on or off"
|
|
892
|
+
},
|
|
893
|
+
{
|
|
894
|
+
"route": "DELETE /api/v1/messenger/comment-automations/:id",
|
|
895
|
+
"scope": "automations:write",
|
|
896
|
+
"summary": "Delete a comment-to-DM automation"
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"route": "GET /api/v1/messenger/profile",
|
|
900
|
+
"scope": "channels:read",
|
|
901
|
+
"summary": "Messenger profile (greeting, menu, ice breakers)"
|
|
902
|
+
},
|
|
903
|
+
{
|
|
904
|
+
"route": "GET /api/v1/messenger/profile/get-started",
|
|
905
|
+
"scope": "channels:read",
|
|
906
|
+
"summary": "Get Started button"
|
|
907
|
+
},
|
|
908
|
+
{
|
|
909
|
+
"route": "POST /api/v1/messenger/profile/get-started",
|
|
910
|
+
"scope": "channels:write",
|
|
911
|
+
"summary": "Set the Get Started button"
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
"route": "DELETE /api/v1/messenger/profile/get-started",
|
|
915
|
+
"scope": "channels:write",
|
|
916
|
+
"summary": "Remove the Get Started button"
|
|
917
|
+
},
|
|
918
|
+
{
|
|
919
|
+
"route": "GET /api/v1/messenger/profile/greeting",
|
|
920
|
+
"scope": "channels:read",
|
|
921
|
+
"summary": "Greeting text"
|
|
922
|
+
},
|
|
923
|
+
{
|
|
924
|
+
"route": "POST /api/v1/messenger/profile/greeting",
|
|
925
|
+
"scope": "channels:write",
|
|
926
|
+
"summary": "Set the greeting text"
|
|
927
|
+
},
|
|
928
|
+
{
|
|
929
|
+
"route": "DELETE /api/v1/messenger/profile/greeting",
|
|
930
|
+
"scope": "channels:write",
|
|
931
|
+
"summary": "Remove the greeting text"
|
|
932
|
+
},
|
|
933
|
+
{
|
|
934
|
+
"route": "GET /api/v1/messenger/profile/ice-breakers",
|
|
935
|
+
"scope": "channels:read",
|
|
936
|
+
"summary": "Ice breakers"
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"route": "POST /api/v1/messenger/profile/ice-breakers",
|
|
940
|
+
"scope": "channels:write",
|
|
941
|
+
"summary": "Set ice breakers"
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
"route": "DELETE /api/v1/messenger/profile/ice-breakers",
|
|
945
|
+
"scope": "channels:write",
|
|
946
|
+
"summary": "Remove ice breakers"
|
|
947
|
+
},
|
|
948
|
+
{
|
|
949
|
+
"route": "GET /api/v1/messenger/profile/persistent-menu",
|
|
950
|
+
"scope": "channels:read",
|
|
951
|
+
"summary": "Persistent menu"
|
|
952
|
+
},
|
|
953
|
+
{
|
|
954
|
+
"route": "POST /api/v1/messenger/profile/persistent-menu",
|
|
955
|
+
"scope": "channels:write",
|
|
956
|
+
"summary": "Set the persistent menu"
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
"route": "DELETE /api/v1/messenger/profile/persistent-menu",
|
|
960
|
+
"scope": "channels:write",
|
|
961
|
+
"summary": "Remove the persistent menu"
|
|
962
|
+
},
|
|
963
|
+
{
|
|
964
|
+
"route": "GET /api/v1/messenger/stats",
|
|
965
|
+
"scope": "analytics:read",
|
|
966
|
+
"summary": "Messenger message totals"
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"route": "GET /api/v1/messenger/analytics/summary",
|
|
970
|
+
"scope": "analytics:read",
|
|
971
|
+
"summary": "Messenger analytics summary"
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"route": "GET /api/v1/messenger/top-performers",
|
|
975
|
+
"scope": "analytics:read",
|
|
976
|
+
"summary": "Top Messenger templates and replies"
|
|
977
|
+
},
|
|
978
|
+
{
|
|
979
|
+
"route": "GET /api/v1/messenger/volume-timeline",
|
|
980
|
+
"scope": "analytics:read",
|
|
981
|
+
"summary": "Messenger message volume over time"
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"route": "GET /api/v1/messenger/rate-limit",
|
|
985
|
+
"scope": "channels:read",
|
|
986
|
+
"summary": "Remaining Messenger send quota"
|
|
987
|
+
},
|
|
988
|
+
{
|
|
989
|
+
"route": "POST /api/v1/telegram/send",
|
|
990
|
+
"scope": "messages:send",
|
|
991
|
+
"summary": "Send a Telegram message"
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
"route": "POST /api/v1/telegram/send/inline-keyboard",
|
|
995
|
+
"scope": "messages:send",
|
|
996
|
+
"summary": "Send a message with inline buttons"
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"route": "POST /api/v1/telegram/send/reply-keyboard",
|
|
1000
|
+
"scope": "messages:send",
|
|
1001
|
+
"summary": "Send a message with a reply keyboard"
|
|
1002
|
+
},
|
|
1003
|
+
{
|
|
1004
|
+
"route": "POST /api/v1/telegram/send/remove-keyboard",
|
|
1005
|
+
"scope": "messages:send",
|
|
1006
|
+
"summary": "Remove the reply keyboard"
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
"route": "POST /api/v1/telegram/send/media-group",
|
|
1010
|
+
"scope": "messages:send",
|
|
1011
|
+
"summary": "Send an album"
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
"route": "POST /api/v1/telegram/send/animation",
|
|
1015
|
+
"scope": "messages:send",
|
|
1016
|
+
"summary": "Send a GIF / animation"
|
|
1017
|
+
},
|
|
1018
|
+
{
|
|
1019
|
+
"route": "POST /api/v1/telegram/send/sticker",
|
|
1020
|
+
"scope": "messages:send",
|
|
1021
|
+
"summary": "Send a sticker"
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"route": "POST /api/v1/telegram/send/video-note",
|
|
1025
|
+
"scope": "messages:send",
|
|
1026
|
+
"summary": "Send a round video note"
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"route": "POST /api/v1/telegram/send/location",
|
|
1030
|
+
"scope": "messages:send",
|
|
1031
|
+
"summary": "Send a location"
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
"route": "POST /api/v1/telegram/send/venue",
|
|
1035
|
+
"scope": "messages:send",
|
|
1036
|
+
"summary": "Send a venue"
|
|
1037
|
+
},
|
|
1038
|
+
{
|
|
1039
|
+
"route": "POST /api/v1/telegram/send/contact",
|
|
1040
|
+
"scope": "messages:send",
|
|
1041
|
+
"summary": "Send a contact"
|
|
1042
|
+
},
|
|
1043
|
+
{
|
|
1044
|
+
"route": "POST /api/v1/telegram/send/poll",
|
|
1045
|
+
"scope": "messages:send",
|
|
1046
|
+
"summary": "Send a poll"
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
"route": "POST /api/v1/telegram/send/dice",
|
|
1050
|
+
"scope": "messages:send",
|
|
1051
|
+
"summary": "Send an animated dice"
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"route": "POST /api/v1/telegram/send/invoice",
|
|
1055
|
+
"scope": "messages:send",
|
|
1056
|
+
"summary": "Send an invoice"
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"route": "POST /api/v1/telegram/create-invoice-link",
|
|
1060
|
+
"scope": "messages:send",
|
|
1061
|
+
"summary": "Create a payment link"
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
"route": "POST /api/v1/telegram/copy",
|
|
1065
|
+
"scope": "messages:send",
|
|
1066
|
+
"summary": "Copy a message to another chat"
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"route": "POST /api/v1/telegram/forward",
|
|
1070
|
+
"scope": "messages:send",
|
|
1071
|
+
"summary": "Forward a message"
|
|
1072
|
+
},
|
|
1073
|
+
{
|
|
1074
|
+
"route": "PUT /api/v1/telegram/message",
|
|
1075
|
+
"scope": "messages:send",
|
|
1076
|
+
"summary": "Edit a sent message"
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"route": "DELETE /api/v1/telegram/message",
|
|
1080
|
+
"scope": "messages:send",
|
|
1081
|
+
"summary": "Delete a message"
|
|
1082
|
+
},
|
|
1083
|
+
{
|
|
1084
|
+
"route": "POST /api/v1/telegram/message/pin",
|
|
1085
|
+
"scope": "messages:send",
|
|
1086
|
+
"summary": "Pin a message"
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"route": "POST /api/v1/telegram/message/unpin",
|
|
1090
|
+
"scope": "messages:send",
|
|
1091
|
+
"summary": "Unpin a message"
|
|
1092
|
+
},
|
|
1093
|
+
{
|
|
1094
|
+
"route": "POST /api/v1/telegram/templates/:id/use",
|
|
1095
|
+
"scope": "messages:send",
|
|
1096
|
+
"summary": "Record a Telegram template use"
|
|
1097
|
+
},
|
|
1098
|
+
{
|
|
1099
|
+
"route": "GET /api/v1/telegram/chat/:chatId",
|
|
1100
|
+
"scope": "conversations:read",
|
|
1101
|
+
"summary": "Get chat info"
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
"route": "GET /api/v1/telegram/chat/:chatId/member-count",
|
|
1105
|
+
"scope": "conversations:read",
|
|
1106
|
+
"summary": "Get group member count"
|
|
1107
|
+
},
|
|
1108
|
+
{
|
|
1109
|
+
"route": "POST /api/v1/telegram/chat/invite-link",
|
|
1110
|
+
"scope": "channels:write",
|
|
1111
|
+
"summary": "Create a group invite link"
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"route": "POST /api/v1/telegram/chat/ban",
|
|
1115
|
+
"scope": "channels:write",
|
|
1116
|
+
"summary": "Ban a user from a group"
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
"route": "POST /api/v1/telegram/chat/unban",
|
|
1120
|
+
"scope": "channels:write",
|
|
1121
|
+
"summary": "Unban a user"
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"route": "GET /api/v1/telegram/templates",
|
|
1125
|
+
"scope": "templates:read",
|
|
1126
|
+
"summary": "List Telegram templates"
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
"route": "GET /api/v1/telegram/templates/:id",
|
|
1130
|
+
"scope": "templates:read",
|
|
1131
|
+
"summary": "Get a Telegram template"
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
"route": "POST /api/v1/telegram/templates",
|
|
1135
|
+
"scope": "templates:write",
|
|
1136
|
+
"summary": "Save a Telegram template"
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"route": "PUT /api/v1/telegram/templates/:id",
|
|
1140
|
+
"scope": "templates:write",
|
|
1141
|
+
"summary": "Update a Telegram template"
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"route": "DELETE /api/v1/telegram/templates/:id",
|
|
1145
|
+
"scope": "templates:write",
|
|
1146
|
+
"summary": "Delete a Telegram template"
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"route": "POST /api/v1/telegram/templates/:id/duplicate",
|
|
1150
|
+
"scope": "templates:write",
|
|
1151
|
+
"summary": "Duplicate a Telegram template"
|
|
1152
|
+
},
|
|
1153
|
+
{
|
|
1154
|
+
"route": "GET /api/v1/telegram/campaigns",
|
|
1155
|
+
"scope": "campaigns:read",
|
|
1156
|
+
"summary": "List Telegram campaigns"
|
|
1157
|
+
},
|
|
1158
|
+
{
|
|
1159
|
+
"route": "GET /api/v1/telegram/campaigns/:id",
|
|
1160
|
+
"scope": "campaigns:read",
|
|
1161
|
+
"summary": "Get a Telegram campaign"
|
|
1162
|
+
},
|
|
1163
|
+
{
|
|
1164
|
+
"route": "POST /api/v1/telegram/campaigns",
|
|
1165
|
+
"scope": "campaigns:write",
|
|
1166
|
+
"summary": "Create a Telegram campaign"
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"route": "DELETE /api/v1/telegram/campaigns/:id",
|
|
1170
|
+
"scope": "campaigns:write",
|
|
1171
|
+
"summary": "Delete a Telegram campaign"
|
|
1172
|
+
},
|
|
1173
|
+
{
|
|
1174
|
+
"route": "POST /api/v1/telegram/campaigns/:id/send",
|
|
1175
|
+
"scope": "campaigns:write",
|
|
1176
|
+
"summary": "Start a Telegram campaign"
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
"route": "POST /api/v1/telegram/campaigns/:id/pause",
|
|
1180
|
+
"scope": "campaigns:write",
|
|
1181
|
+
"summary": "Pause a Telegram campaign"
|
|
1182
|
+
},
|
|
1183
|
+
{
|
|
1184
|
+
"route": "POST /api/v1/telegram/campaigns/:id/resume",
|
|
1185
|
+
"scope": "campaigns:write",
|
|
1186
|
+
"summary": "Resume a Telegram campaign"
|
|
1187
|
+
},
|
|
1188
|
+
{
|
|
1189
|
+
"route": "POST /api/v1/telegram/campaigns/:id/cancel",
|
|
1190
|
+
"scope": "campaigns:write",
|
|
1191
|
+
"summary": "Cancel a Telegram campaign"
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"route": "GET /api/v1/telegram/commands",
|
|
1195
|
+
"scope": "channels:read",
|
|
1196
|
+
"summary": "List bot commands"
|
|
1197
|
+
},
|
|
1198
|
+
{
|
|
1199
|
+
"route": "POST /api/v1/telegram/commands",
|
|
1200
|
+
"scope": "channels:write",
|
|
1201
|
+
"summary": "Set bot commands"
|
|
1202
|
+
},
|
|
1203
|
+
{
|
|
1204
|
+
"route": "DELETE /api/v1/telegram/commands",
|
|
1205
|
+
"scope": "channels:write",
|
|
1206
|
+
"summary": "Remove bot commands"
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"route": "GET /api/v1/telegram/bot/profile",
|
|
1210
|
+
"scope": "channels:read",
|
|
1211
|
+
"summary": "Bot name, description and about text"
|
|
1212
|
+
},
|
|
1213
|
+
{
|
|
1214
|
+
"route": "PUT /api/v1/telegram/bot/profile",
|
|
1215
|
+
"scope": "channels:write",
|
|
1216
|
+
"summary": "Change the bot name, description and about text"
|
|
1217
|
+
},
|
|
1218
|
+
{
|
|
1219
|
+
"route": "GET /api/v1/telegram/stats",
|
|
1220
|
+
"scope": "analytics:read",
|
|
1221
|
+
"summary": "Telegram message totals"
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"route": "GET /api/v1/telegram/top-performers",
|
|
1225
|
+
"scope": "analytics:read",
|
|
1226
|
+
"summary": "Top Telegram templates"
|
|
1227
|
+
},
|
|
1228
|
+
{
|
|
1229
|
+
"route": "GET /api/v1/telegram/volume-timeline",
|
|
1230
|
+
"scope": "analytics:read",
|
|
1231
|
+
"summary": "Telegram message volume over time"
|
|
1232
|
+
},
|
|
1233
|
+
{
|
|
1234
|
+
"route": "GET /api/v1/automations-v2",
|
|
1235
|
+
"scope": "automations:read",
|
|
1236
|
+
"summary": "List workflows"
|
|
1237
|
+
},
|
|
1238
|
+
{
|
|
1239
|
+
"route": "GET /api/v1/automations-v2/:workflowId",
|
|
1240
|
+
"scope": "automations:read",
|
|
1241
|
+
"summary": "Get a workflow"
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
"route": "GET /api/v1/automations-v2/:workflowId/activation-preview",
|
|
1245
|
+
"scope": "automations:read",
|
|
1246
|
+
"summary": "Preview the exact published workflow before activation"
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"route": "POST /api/v1/automations-v2/:workflowId/activate",
|
|
1250
|
+
"scope": "automations:write",
|
|
1251
|
+
"summary": "Activate the exact approved workflow snapshot"
|
|
1252
|
+
},
|
|
1253
|
+
{
|
|
1254
|
+
"route": "GET /api/v1/automations-v2/:workflowId/graph",
|
|
1255
|
+
"scope": "automations:read",
|
|
1256
|
+
"summary": "Get a workflow with its nodes and edges"
|
|
1257
|
+
},
|
|
1258
|
+
{
|
|
1259
|
+
"route": "GET /api/v1/automations-v2/:workflowId/export",
|
|
1260
|
+
"scope": "automations:read",
|
|
1261
|
+
"summary": "Export a workflow as a portable document"
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
1264
|
+
"route": "GET /api/v1/automations-v2/:workflowId/runs",
|
|
1265
|
+
"scope": "automations:read",
|
|
1266
|
+
"summary": "List runs (execution history)"
|
|
1267
|
+
},
|
|
1268
|
+
{
|
|
1269
|
+
"route": "GET /api/v1/automations-v2/:workflowId/runs/:runId",
|
|
1270
|
+
"scope": "automations:read",
|
|
1271
|
+
"summary": "Get one run with its steps"
|
|
1272
|
+
},
|
|
1273
|
+
{
|
|
1274
|
+
"route": "GET /api/v1/automations-v2/:workflowId/sample-events",
|
|
1275
|
+
"scope": "automations:read",
|
|
1276
|
+
"summary": "Recent real events this workflow’s trigger would receive"
|
|
1277
|
+
},
|
|
1278
|
+
{
|
|
1279
|
+
"route": "GET /api/v1/automations-v2/:workflowId/stats",
|
|
1280
|
+
"scope": "analytics:read",
|
|
1281
|
+
"summary": "Run statistics for a workflow"
|
|
1282
|
+
},
|
|
1283
|
+
{
|
|
1284
|
+
"route": "POST /api/v1/automations-v2",
|
|
1285
|
+
"scope": "automations:write",
|
|
1286
|
+
"summary": "Create a workflow"
|
|
1287
|
+
},
|
|
1288
|
+
{
|
|
1289
|
+
"route": "POST /api/v1/automations-v2/import",
|
|
1290
|
+
"scope": "automations:write",
|
|
1291
|
+
"summary": "Import a workflow document"
|
|
1292
|
+
},
|
|
1293
|
+
{
|
|
1294
|
+
"route": "POST /api/v1/automations-v2/:workflowId/publish",
|
|
1295
|
+
"scope": "automations:write",
|
|
1296
|
+
"summary": "Validate and publish a workflow graph"
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
"route": "PATCH /api/v1/automations-v2/:workflowId/status",
|
|
1300
|
+
"scope": "automations:write",
|
|
1301
|
+
"summary": "Turn a workflow on, pause or archive it"
|
|
1302
|
+
},
|
|
1303
|
+
{
|
|
1304
|
+
"route": "POST /api/v1/automations-v2/:workflowId/test-run",
|
|
1305
|
+
"scope": "automations:write",
|
|
1306
|
+
"summary": "Dry-run a workflow on a sample event (nothing is sent)"
|
|
1307
|
+
},
|
|
1308
|
+
{
|
|
1309
|
+
"route": "POST /api/v1/automations-v2/:workflowId/test-arm",
|
|
1310
|
+
"scope": "automations:write",
|
|
1311
|
+
"summary": "Capture the next real trigger event as a sample (60 seconds)"
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
"route": "DELETE /api/v1/automations-v2/:workflowId",
|
|
1315
|
+
"scope": "automations:write",
|
|
1316
|
+
"summary": "Delete a workflow"
|
|
1317
|
+
},
|
|
1318
|
+
{
|
|
1319
|
+
"route": "GET /api/v1/web-events",
|
|
1320
|
+
"scope": "automations:read",
|
|
1321
|
+
"summary": "List web event integrations"
|
|
1322
|
+
},
|
|
1323
|
+
{
|
|
1324
|
+
"route": "GET /api/v1/web-events/:id",
|
|
1325
|
+
"scope": "automations:read",
|
|
1326
|
+
"summary": "Get a web event integration"
|
|
1327
|
+
},
|
|
1328
|
+
{
|
|
1329
|
+
"route": "GET /api/v1/web-events/:id/logs",
|
|
1330
|
+
"scope": "automations:read",
|
|
1331
|
+
"summary": "List received events"
|
|
1332
|
+
},
|
|
1333
|
+
{
|
|
1334
|
+
"route": "GET /api/v1/web-events/:id/logs/:logId",
|
|
1335
|
+
"scope": "automations:read",
|
|
1336
|
+
"summary": "Get one received event"
|
|
1337
|
+
},
|
|
1338
|
+
{
|
|
1339
|
+
"route": "GET /api/v1/web-events/:id/variables",
|
|
1340
|
+
"scope": "automations:read",
|
|
1341
|
+
"summary": "Variables this integration exposes to automations and templates"
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
"route": "POST /api/v1/web-events",
|
|
1345
|
+
"scope": "automations:write",
|
|
1346
|
+
"summary": "Create an integration your website posts events to"
|
|
1347
|
+
},
|
|
1348
|
+
{
|
|
1349
|
+
"route": "PUT /api/v1/web-events/:id",
|
|
1350
|
+
"scope": "automations:write",
|
|
1351
|
+
"summary": "Update an integration"
|
|
1352
|
+
},
|
|
1353
|
+
{
|
|
1354
|
+
"route": "DELETE /api/v1/web-events/:id",
|
|
1355
|
+
"scope": "automations:write",
|
|
1356
|
+
"summary": "Delete an integration"
|
|
1357
|
+
},
|
|
1358
|
+
{
|
|
1359
|
+
"route": "PATCH /api/v1/web-events/:id/toggle",
|
|
1360
|
+
"scope": "automations:write",
|
|
1361
|
+
"summary": "Enable or disable an integration"
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"route": "POST /api/v1/web-events/:id/event-types",
|
|
1365
|
+
"scope": "automations:write",
|
|
1366
|
+
"summary": "Declare an event type"
|
|
1367
|
+
},
|
|
1368
|
+
{
|
|
1369
|
+
"route": "DELETE /api/v1/web-events/:id/event-types/:typeId",
|
|
1370
|
+
"scope": "automations:write",
|
|
1371
|
+
"summary": "Remove an event type"
|
|
1372
|
+
},
|
|
1373
|
+
{
|
|
1374
|
+
"route": "POST /api/v1/web-events/:id/test",
|
|
1375
|
+
"scope": "automations:write",
|
|
1376
|
+
"summary": "Send a test event through the integration"
|
|
1377
|
+
},
|
|
1378
|
+
{
|
|
1379
|
+
"route": "GET /api/v1/orders",
|
|
1380
|
+
"scope": "orders:read",
|
|
1381
|
+
"summary": "List orders"
|
|
1382
|
+
},
|
|
1383
|
+
{
|
|
1384
|
+
"route": "GET /api/v1/orders/stats",
|
|
1385
|
+
"scope": "orders:read",
|
|
1386
|
+
"summary": "Order statistics"
|
|
1387
|
+
},
|
|
1388
|
+
{
|
|
1389
|
+
"route": "GET /api/v1/orders/:id",
|
|
1390
|
+
"scope": "orders:read",
|
|
1391
|
+
"summary": "Get an order"
|
|
1392
|
+
},
|
|
1393
|
+
{
|
|
1394
|
+
"route": "GET /api/v1/orders/:id/messages",
|
|
1395
|
+
"scope": "orders:read",
|
|
1396
|
+
"summary": "Messages linked to an order"
|
|
1397
|
+
},
|
|
1398
|
+
{
|
|
1399
|
+
"route": "GET /api/v1/orders/:id/confirmation-thread",
|
|
1400
|
+
"scope": "orders:read",
|
|
1401
|
+
"summary": "The WhatsApp confirmation exchange for an order"
|
|
1402
|
+
},
|
|
1403
|
+
{
|
|
1404
|
+
"route": "PATCH /api/v1/orders/:id/confirmation",
|
|
1405
|
+
"scope": "orders:write",
|
|
1406
|
+
"summary": "Set the order confirmation status"
|
|
1407
|
+
},
|
|
1408
|
+
{
|
|
1409
|
+
"route": "POST /api/v1/orders/:id/messages",
|
|
1410
|
+
"scope": "orders:write",
|
|
1411
|
+
"summary": "Link a message to an order"
|
|
1412
|
+
},
|
|
1413
|
+
{
|
|
1414
|
+
"route": "POST /api/v1/orders/:id/push-to-platform",
|
|
1415
|
+
"scope": "orders:write",
|
|
1416
|
+
"summary": "Push an Inboxy-created order to the connected store (Shopify, Salla, WooCommerce)"
|
|
1417
|
+
},
|
|
1418
|
+
{
|
|
1419
|
+
"route": "DELETE /api/v1/orders/:id",
|
|
1420
|
+
"scope": "orders:write",
|
|
1421
|
+
"summary": "Delete an order"
|
|
1422
|
+
},
|
|
1423
|
+
{
|
|
1424
|
+
"route": "GET /api/v1/products",
|
|
1425
|
+
"scope": "products:read",
|
|
1426
|
+
"summary": "List products"
|
|
1427
|
+
},
|
|
1428
|
+
{
|
|
1429
|
+
"route": "GET /api/v1/products/stats",
|
|
1430
|
+
"scope": "products:read",
|
|
1431
|
+
"summary": "Product statistics"
|
|
1432
|
+
},
|
|
1433
|
+
{
|
|
1434
|
+
"route": "GET /api/v1/products/:id",
|
|
1435
|
+
"scope": "products:read",
|
|
1436
|
+
"summary": "Get a product"
|
|
1437
|
+
},
|
|
1438
|
+
{
|
|
1439
|
+
"route": "PUT /api/v1/products/categories/:id",
|
|
1440
|
+
"scope": "products:write",
|
|
1441
|
+
"summary": "Update a product category"
|
|
1442
|
+
},
|
|
1443
|
+
{
|
|
1444
|
+
"route": "DELETE /api/v1/products/categories/:id",
|
|
1445
|
+
"scope": "products:write",
|
|
1446
|
+
"summary": "Delete a product category"
|
|
1447
|
+
},
|
|
1448
|
+
{
|
|
1449
|
+
"route": "POST /api/v1/products/merge",
|
|
1450
|
+
"scope": "products:write",
|
|
1451
|
+
"summary": "Merge a duplicate product into another"
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"route": "POST /api/v1/products/import-from-url/save",
|
|
1455
|
+
"scope": "products:write",
|
|
1456
|
+
"summary": "Save extracted products"
|
|
1457
|
+
},
|
|
1458
|
+
{
|
|
1459
|
+
"route": "GET /api/v1/services",
|
|
1460
|
+
"scope": "products:read",
|
|
1461
|
+
"summary": "List services"
|
|
1462
|
+
},
|
|
1463
|
+
{
|
|
1464
|
+
"route": "GET /api/v1/services/stats",
|
|
1465
|
+
"scope": "products:read",
|
|
1466
|
+
"summary": "Service statistics"
|
|
1467
|
+
},
|
|
1468
|
+
{
|
|
1469
|
+
"route": "GET /api/v1/services/categories",
|
|
1470
|
+
"scope": "products:read",
|
|
1471
|
+
"summary": "List service categories"
|
|
1472
|
+
},
|
|
1473
|
+
{
|
|
1474
|
+
"route": "GET /api/v1/services/:id",
|
|
1475
|
+
"scope": "products:read",
|
|
1476
|
+
"summary": "Get a service"
|
|
1477
|
+
},
|
|
1478
|
+
{
|
|
1479
|
+
"route": "POST /api/v1/services",
|
|
1480
|
+
"scope": "products:write",
|
|
1481
|
+
"summary": "Create a service"
|
|
1482
|
+
},
|
|
1483
|
+
{
|
|
1484
|
+
"route": "PUT /api/v1/services/:id",
|
|
1485
|
+
"scope": "products:write",
|
|
1486
|
+
"summary": "Update a service"
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"route": "DELETE /api/v1/services/:id",
|
|
1490
|
+
"scope": "products:write",
|
|
1491
|
+
"summary": "Delete a service"
|
|
1492
|
+
},
|
|
1493
|
+
{
|
|
1494
|
+
"route": "POST /api/v1/services/categories",
|
|
1495
|
+
"scope": "products:write",
|
|
1496
|
+
"summary": "Create a service category"
|
|
1497
|
+
},
|
|
1498
|
+
{
|
|
1499
|
+
"route": "PUT /api/v1/services/categories/:id",
|
|
1500
|
+
"scope": "products:write",
|
|
1501
|
+
"summary": "Update a service category"
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
"route": "DELETE /api/v1/services/categories/:id",
|
|
1505
|
+
"scope": "products:write",
|
|
1506
|
+
"summary": "Delete a service category"
|
|
1507
|
+
},
|
|
1508
|
+
{
|
|
1509
|
+
"route": "GET /api/v1/catalog-cards",
|
|
1510
|
+
"scope": "products:read",
|
|
1511
|
+
"summary": "List catalog cards (products and services ready to send)"
|
|
1512
|
+
},
|
|
1513
|
+
{
|
|
1514
|
+
"route": "GET /api/v1/catalog-cards/status",
|
|
1515
|
+
"scope": "products:read",
|
|
1516
|
+
"summary": "Store sync state and card readiness"
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
"route": "GET /api/v1/catalog-cards/:itemType/:itemId",
|
|
1520
|
+
"scope": "products:read",
|
|
1521
|
+
"summary": "Preview one catalog card"
|
|
1522
|
+
},
|
|
1523
|
+
{
|
|
1524
|
+
"route": "POST /api/v1/catalog-cards/sync",
|
|
1525
|
+
"scope": "products:write",
|
|
1526
|
+
"summary": "Sync the catalog from a connected store"
|
|
1527
|
+
},
|
|
1528
|
+
{
|
|
1529
|
+
"route": "POST /api/v1/catalog-cards/send/whatsapp",
|
|
1530
|
+
"scope": "messages:send",
|
|
1531
|
+
"summary": "Send a catalog card on WhatsApp"
|
|
1532
|
+
},
|
|
1533
|
+
{
|
|
1534
|
+
"route": "POST /api/v1/catalog-cards/send/instagram",
|
|
1535
|
+
"scope": "messages:send",
|
|
1536
|
+
"summary": "Send a catalog card on Instagram"
|
|
1537
|
+
},
|
|
1538
|
+
{
|
|
1539
|
+
"route": "POST /api/v1/catalog-cards/send/messenger",
|
|
1540
|
+
"scope": "messages:send",
|
|
1541
|
+
"summary": "Send a catalog card on Messenger"
|
|
1542
|
+
},
|
|
1543
|
+
{
|
|
1544
|
+
"route": "POST /api/v1/catalog-cards/send/telegram",
|
|
1545
|
+
"scope": "messages:send",
|
|
1546
|
+
"summary": "Send a catalog card on Telegram"
|
|
1547
|
+
},
|
|
1548
|
+
{
|
|
1549
|
+
"route": "POST /api/v1/catalog-cards/send/web",
|
|
1550
|
+
"scope": "messages:send",
|
|
1551
|
+
"summary": "Send a catalog card in the website chat"
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
"route": "GET /api/v1/ecommerce/overview",
|
|
1555
|
+
"scope": "ecommerce:read",
|
|
1556
|
+
"summary": "Store KPIs: orders, revenue, store connectivity"
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
"route": "GET /api/v1/ecommerce/customers",
|
|
1560
|
+
"scope": "ecommerce:read",
|
|
1561
|
+
"summary": "List store customers across platforms"
|
|
1562
|
+
},
|
|
1563
|
+
{
|
|
1564
|
+
"route": "GET /api/v1/ecommerce/customers/:id",
|
|
1565
|
+
"scope": "ecommerce:read",
|
|
1566
|
+
"summary": "Get a store customer with orders"
|
|
1567
|
+
},
|
|
1568
|
+
{
|
|
1569
|
+
"route": "GET /api/v1/shopify/config",
|
|
1570
|
+
"scope": "channels:read",
|
|
1571
|
+
"summary": "Shopify connection status (no secrets)"
|
|
1572
|
+
},
|
|
1573
|
+
{
|
|
1574
|
+
"route": "POST /api/v1/shopify/sync",
|
|
1575
|
+
"scope": "channels:write",
|
|
1576
|
+
"summary": "Sync everything from Shopify"
|
|
1577
|
+
},
|
|
1578
|
+
{
|
|
1579
|
+
"route": "POST /api/v1/shopify/sync/customers",
|
|
1580
|
+
"scope": "channels:write",
|
|
1581
|
+
"summary": "Sync Shopify customers"
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"route": "POST /api/v1/shopify/sync/orders",
|
|
1585
|
+
"scope": "channels:write",
|
|
1586
|
+
"summary": "Sync Shopify orders"
|
|
1587
|
+
},
|
|
1588
|
+
{
|
|
1589
|
+
"route": "POST /api/v1/shopify/sync/products",
|
|
1590
|
+
"scope": "channels:write",
|
|
1591
|
+
"summary": "Sync Shopify products"
|
|
1592
|
+
},
|
|
1593
|
+
{
|
|
1594
|
+
"route": "GET /api/v1/salla/config",
|
|
1595
|
+
"scope": "channels:read",
|
|
1596
|
+
"summary": "Salla connection status (no secrets)"
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"route": "POST /api/v1/salla/sync",
|
|
1600
|
+
"scope": "channels:write",
|
|
1601
|
+
"summary": "Sync from Salla"
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"route": "GET /api/v1/zid/config",
|
|
1605
|
+
"scope": "channels:read",
|
|
1606
|
+
"summary": "Zid connection status (no secrets)"
|
|
1607
|
+
},
|
|
1608
|
+
{
|
|
1609
|
+
"route": "POST /api/v1/zid/sync",
|
|
1610
|
+
"scope": "channels:write",
|
|
1611
|
+
"summary": "Sync orders from Zid"
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
"route": "GET /api/v1/easy-orders/config",
|
|
1615
|
+
"scope": "channels:read",
|
|
1616
|
+
"summary": "EasyOrders connection status (no secrets)"
|
|
1617
|
+
},
|
|
1618
|
+
{
|
|
1619
|
+
"route": "POST /api/v1/easy-orders/sync",
|
|
1620
|
+
"scope": "channels:write",
|
|
1621
|
+
"summary": "Sync from EasyOrders"
|
|
1622
|
+
},
|
|
1623
|
+
{
|
|
1624
|
+
"route": "POST /api/v1/woocommerce/sync",
|
|
1625
|
+
"scope": "channels:write",
|
|
1626
|
+
"summary": "Sync from WooCommerce (?full=true for a full reconcile)"
|
|
1627
|
+
},
|
|
1628
|
+
{
|
|
1629
|
+
"route": "POST /api/v1/woocommerce/sync/customers",
|
|
1630
|
+
"scope": "channels:write",
|
|
1631
|
+
"summary": "Sync WooCommerce customers"
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"route": "POST /api/v1/woocommerce/sync/orders",
|
|
1635
|
+
"scope": "channels:write",
|
|
1636
|
+
"summary": "Sync WooCommerce orders"
|
|
1637
|
+
},
|
|
1638
|
+
{
|
|
1639
|
+
"route": "POST /api/v1/woocommerce/sync/products",
|
|
1640
|
+
"scope": "channels:write",
|
|
1641
|
+
"summary": "Sync WooCommerce products"
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"route": "GET /api/v1/woocommerce/abandoned-carts",
|
|
1645
|
+
"scope": "ecommerce:read",
|
|
1646
|
+
"summary": "WooCommerce abandoned carts"
|
|
1647
|
+
},
|
|
1648
|
+
{
|
|
1649
|
+
"route": "GET /api/v1/woocommerce/abandoned-carts/stats",
|
|
1650
|
+
"scope": "ecommerce:read",
|
|
1651
|
+
"summary": "WooCommerce cart recovery stats"
|
|
1652
|
+
},
|
|
1653
|
+
{
|
|
1654
|
+
"route": "PATCH /api/v1/woocommerce/abandoned-carts/:id/recover",
|
|
1655
|
+
"scope": "ecommerce:write",
|
|
1656
|
+
"summary": "Mark a WooCommerce cart recovered"
|
|
1657
|
+
},
|
|
1658
|
+
{
|
|
1659
|
+
"route": "GET /api/v1/salla/abandoned-carts",
|
|
1660
|
+
"scope": "ecommerce:read",
|
|
1661
|
+
"summary": "Salla abandoned carts"
|
|
1662
|
+
},
|
|
1663
|
+
{
|
|
1664
|
+
"route": "GET /api/v1/salla/abandoned-carts/stats",
|
|
1665
|
+
"scope": "ecommerce:read",
|
|
1666
|
+
"summary": "Salla cart recovery stats"
|
|
1667
|
+
},
|
|
1668
|
+
{
|
|
1669
|
+
"route": "PATCH /api/v1/salla/abandoned-carts/:id/recover",
|
|
1670
|
+
"scope": "ecommerce:write",
|
|
1671
|
+
"summary": "Mark a Salla cart recovered"
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"route": "GET /api/v1/zid/abandoned-carts",
|
|
1675
|
+
"scope": "ecommerce:read",
|
|
1676
|
+
"summary": "Zid abandoned carts"
|
|
1677
|
+
},
|
|
1678
|
+
{
|
|
1679
|
+
"route": "GET /api/v1/whatsapp/stats",
|
|
1680
|
+
"scope": "analytics:read",
|
|
1681
|
+
"summary": "WhatsApp message and conversation totals"
|
|
1682
|
+
},
|
|
1683
|
+
{
|
|
1684
|
+
"route": "GET /api/v1/whatsapp/analytics/summary",
|
|
1685
|
+
"scope": "analytics:read",
|
|
1686
|
+
"summary": "WhatsApp analytics summary"
|
|
1687
|
+
},
|
|
1688
|
+
{
|
|
1689
|
+
"route": "GET /api/v1/whatsapp/analytics/messages",
|
|
1690
|
+
"scope": "analytics:read",
|
|
1691
|
+
"summary": "Message volume"
|
|
1692
|
+
},
|
|
1693
|
+
{
|
|
1694
|
+
"route": "GET /api/v1/whatsapp/analytics/messages/trends",
|
|
1695
|
+
"scope": "analytics:read",
|
|
1696
|
+
"summary": "Message trends"
|
|
1697
|
+
},
|
|
1698
|
+
{
|
|
1699
|
+
"route": "GET /api/v1/whatsapp/analytics/response-times",
|
|
1700
|
+
"scope": "analytics:read",
|
|
1701
|
+
"summary": "Response times"
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"route": "GET /api/v1/whatsapp/analytics/templates",
|
|
1705
|
+
"scope": "analytics:read",
|
|
1706
|
+
"summary": "Template performance"
|
|
1707
|
+
},
|
|
1708
|
+
{
|
|
1709
|
+
"route": "GET /api/v1/whatsapp/analytics/conversations",
|
|
1710
|
+
"scope": "analytics:read",
|
|
1711
|
+
"summary": "Conversation metrics"
|
|
1712
|
+
},
|
|
1713
|
+
{
|
|
1714
|
+
"route": "GET /api/v1/whatsapp/analytics/agents",
|
|
1715
|
+
"scope": "analytics:read",
|
|
1716
|
+
"summary": "Agent performance"
|
|
1717
|
+
},
|
|
1718
|
+
{
|
|
1719
|
+
"route": "GET /api/v1/whatsapp/analytics/channels",
|
|
1720
|
+
"scope": "analytics:read",
|
|
1721
|
+
"summary": "Channel breakdown"
|
|
1722
|
+
},
|
|
1723
|
+
{
|
|
1724
|
+
"route": "GET /api/v1/inbox/conversations",
|
|
1725
|
+
"scope": "conversations:read",
|
|
1726
|
+
"summary": "List inbox conversations"
|
|
1727
|
+
},
|
|
1728
|
+
{
|
|
1729
|
+
"route": "GET /api/v1/inbox/conversations/:conversationId",
|
|
1730
|
+
"scope": "conversations:read",
|
|
1731
|
+
"summary": "Get a conversation"
|
|
1732
|
+
},
|
|
1733
|
+
{
|
|
1734
|
+
"route": "GET /api/v1/inbox/conversations/:conversationId/messages",
|
|
1735
|
+
"scope": "messages:read",
|
|
1736
|
+
"summary": "List messages in a conversation"
|
|
1737
|
+
},
|
|
1738
|
+
{
|
|
1739
|
+
"route": "GET /api/v1/inbox/conversations/:conversationId/window",
|
|
1740
|
+
"scope": "conversations:read",
|
|
1741
|
+
"summary": "Check the 24-hour messaging window"
|
|
1742
|
+
},
|
|
1743
|
+
{
|
|
1744
|
+
"route": "PATCH /api/v1/inbox/conversations/:conversationId/status",
|
|
1745
|
+
"scope": "conversations:write",
|
|
1746
|
+
"summary": "Change conversation status"
|
|
1747
|
+
},
|
|
1748
|
+
{
|
|
1749
|
+
"route": "PATCH /api/v1/inbox/conversations/:conversationId/assign",
|
|
1750
|
+
"scope": "conversations:write",
|
|
1751
|
+
"summary": "Assign a conversation to an agent"
|
|
1752
|
+
},
|
|
1753
|
+
{
|
|
1754
|
+
"route": "PATCH /api/v1/inbox/conversations/:conversationId/labels",
|
|
1755
|
+
"scope": "conversations:write",
|
|
1756
|
+
"summary": "Set conversation labels"
|
|
1757
|
+
},
|
|
1758
|
+
{
|
|
1759
|
+
"route": "GET /api/v1/inbox/conversations/:conversationId/notes/list",
|
|
1760
|
+
"scope": "conversations:read",
|
|
1761
|
+
"summary": "List internal notes"
|
|
1762
|
+
},
|
|
1763
|
+
{
|
|
1764
|
+
"route": "POST /api/v1/inbox/conversations/:conversationId/notes/list",
|
|
1765
|
+
"scope": "conversations:write",
|
|
1766
|
+
"summary": "Add an internal note"
|
|
1767
|
+
},
|
|
1768
|
+
{
|
|
1769
|
+
"route": "GET /api/v1/contacts",
|
|
1770
|
+
"scope": "contacts:read",
|
|
1771
|
+
"summary": "List contacts"
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
"route": "GET /api/v1/contacts/search",
|
|
1775
|
+
"scope": "contacts:read",
|
|
1776
|
+
"summary": "Search contacts"
|
|
1777
|
+
},
|
|
1778
|
+
{
|
|
1779
|
+
"route": "GET /api/v1/contacts/custom-field-keys",
|
|
1780
|
+
"scope": "contacts:read",
|
|
1781
|
+
"summary": "List custom field keys"
|
|
1782
|
+
},
|
|
1783
|
+
{
|
|
1784
|
+
"route": "GET /api/v1/contacts/:id",
|
|
1785
|
+
"scope": "contacts:read",
|
|
1786
|
+
"summary": "Get a contact"
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"route": "GET /api/v1/contacts/:id/timeline",
|
|
1790
|
+
"scope": "contacts:read",
|
|
1791
|
+
"summary": "Get a contact timeline"
|
|
1792
|
+
},
|
|
1793
|
+
{
|
|
1794
|
+
"route": "GET /api/v1/contacts/tags/all",
|
|
1795
|
+
"scope": "contacts:read",
|
|
1796
|
+
"summary": "List tags"
|
|
1797
|
+
},
|
|
1798
|
+
{
|
|
1799
|
+
"route": "POST /api/v1/contacts",
|
|
1800
|
+
"scope": "contacts:write",
|
|
1801
|
+
"summary": "Create a contact"
|
|
1802
|
+
},
|
|
1803
|
+
{
|
|
1804
|
+
"route": "POST /api/v1/contacts/find-or-create",
|
|
1805
|
+
"scope": "contacts:write",
|
|
1806
|
+
"summary": "Find a contact or create it"
|
|
1807
|
+
},
|
|
1808
|
+
{
|
|
1809
|
+
"route": "PUT /api/v1/contacts/:id",
|
|
1810
|
+
"scope": "contacts:write",
|
|
1811
|
+
"summary": "Update a contact"
|
|
1812
|
+
},
|
|
1813
|
+
{
|
|
1814
|
+
"route": "DELETE /api/v1/contacts/:id",
|
|
1815
|
+
"scope": "contacts:write",
|
|
1816
|
+
"summary": "Delete a contact"
|
|
1817
|
+
},
|
|
1818
|
+
{
|
|
1819
|
+
"route": "POST /api/v1/contacts/:id/tags/:tagId",
|
|
1820
|
+
"scope": "contacts:write",
|
|
1821
|
+
"summary": "Add a tag to a contact"
|
|
1822
|
+
},
|
|
1823
|
+
{
|
|
1824
|
+
"route": "DELETE /api/v1/contacts/:id/tags/:tagId",
|
|
1825
|
+
"scope": "contacts:write",
|
|
1826
|
+
"summary": "Remove a tag from a contact"
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
"route": "POST /api/v1/contacts/tags",
|
|
1830
|
+
"scope": "contacts:write",
|
|
1831
|
+
"summary": "Create a tag"
|
|
1832
|
+
},
|
|
1833
|
+
{
|
|
1834
|
+
"route": "PUT /api/v1/contacts/tags/:tagId",
|
|
1835
|
+
"scope": "contacts:write",
|
|
1836
|
+
"summary": "Update a tag"
|
|
1837
|
+
},
|
|
1838
|
+
{
|
|
1839
|
+
"route": "DELETE /api/v1/contacts/tags/:tagId",
|
|
1840
|
+
"scope": "contacts:write",
|
|
1841
|
+
"summary": "Delete a tag"
|
|
1842
|
+
},
|
|
1843
|
+
{
|
|
1844
|
+
"route": "PATCH /api/v1/contacts/:id/status",
|
|
1845
|
+
"scope": "contacts:write",
|
|
1846
|
+
"summary": "Set contact status"
|
|
1847
|
+
},
|
|
1848
|
+
{
|
|
1849
|
+
"route": "PATCH /api/v1/contacts/:id/stage",
|
|
1850
|
+
"scope": "contacts:write",
|
|
1851
|
+
"summary": "Set contact lifecycle stage"
|
|
1852
|
+
},
|
|
1853
|
+
{
|
|
1854
|
+
"route": "PATCH /api/v1/contacts/:id/assign",
|
|
1855
|
+
"scope": "contacts:write",
|
|
1856
|
+
"summary": "Assign a contact to an agent"
|
|
1857
|
+
},
|
|
1858
|
+
{
|
|
1859
|
+
"route": "POST /api/v1/contacts/:id/note",
|
|
1860
|
+
"scope": "contacts:write",
|
|
1861
|
+
"summary": "Add a note to a contact"
|
|
1862
|
+
},
|
|
1863
|
+
{
|
|
1864
|
+
"route": "POST /api/v1/contacts/bulk/tags",
|
|
1865
|
+
"scope": "contacts:write",
|
|
1866
|
+
"summary": "Tag many contacts"
|
|
1867
|
+
},
|
|
1868
|
+
{
|
|
1869
|
+
"route": "GET /api/v1/tasks",
|
|
1870
|
+
"scope": "tasks:read",
|
|
1871
|
+
"summary": "List tasks"
|
|
1872
|
+
},
|
|
1873
|
+
{
|
|
1874
|
+
"route": "GET /api/v1/tasks/stats",
|
|
1875
|
+
"scope": "tasks:read",
|
|
1876
|
+
"summary": "Get task stats"
|
|
1877
|
+
},
|
|
1878
|
+
{
|
|
1879
|
+
"route": "GET /api/v1/tasks/my",
|
|
1880
|
+
"scope": "tasks:read",
|
|
1881
|
+
"summary": "List tasks assigned to the token owner"
|
|
1882
|
+
},
|
|
1883
|
+
{
|
|
1884
|
+
"route": "GET /api/v1/tasks/contact/:contactId",
|
|
1885
|
+
"scope": "tasks:read",
|
|
1886
|
+
"summary": "List tasks for a contact"
|
|
1887
|
+
},
|
|
1888
|
+
{
|
|
1889
|
+
"route": "GET /api/v1/tasks/:id",
|
|
1890
|
+
"scope": "tasks:read",
|
|
1891
|
+
"summary": "Get a task"
|
|
1892
|
+
},
|
|
1893
|
+
{
|
|
1894
|
+
"route": "POST /api/v1/tasks",
|
|
1895
|
+
"scope": "tasks:write",
|
|
1896
|
+
"summary": "Create a task"
|
|
1897
|
+
},
|
|
1898
|
+
{
|
|
1899
|
+
"route": "PUT /api/v1/tasks/:id",
|
|
1900
|
+
"scope": "tasks:write",
|
|
1901
|
+
"summary": "Update a task"
|
|
1902
|
+
},
|
|
1903
|
+
{
|
|
1904
|
+
"route": "DELETE /api/v1/tasks/:id",
|
|
1905
|
+
"scope": "tasks:write",
|
|
1906
|
+
"summary": "Delete a task"
|
|
1907
|
+
},
|
|
1908
|
+
{
|
|
1909
|
+
"route": "POST /api/v1/tasks/:id/complete",
|
|
1910
|
+
"scope": "tasks:write",
|
|
1911
|
+
"summary": "Mark a task complete"
|
|
1912
|
+
},
|
|
1913
|
+
{
|
|
1914
|
+
"route": "POST /api/v1/tasks/:id/assign",
|
|
1915
|
+
"scope": "tasks:write",
|
|
1916
|
+
"summary": "Assign a task"
|
|
1917
|
+
},
|
|
1918
|
+
{
|
|
1919
|
+
"route": "GET /api/v1/tasks/:id/subtasks",
|
|
1920
|
+
"scope": "tasks:read",
|
|
1921
|
+
"summary": "List checklist items on a task"
|
|
1922
|
+
},
|
|
1923
|
+
{
|
|
1924
|
+
"route": "POST /api/v1/tasks/:id/subtasks",
|
|
1925
|
+
"scope": "tasks:write",
|
|
1926
|
+
"summary": "Add a checklist item to a task"
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
"route": "PATCH /api/v1/tasks/subtasks/:subtaskId",
|
|
1930
|
+
"scope": "tasks:write",
|
|
1931
|
+
"summary": "Toggle a checklist item"
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
"route": "DELETE /api/v1/tasks/subtasks/:subtaskId",
|
|
1935
|
+
"scope": "tasks:write",
|
|
1936
|
+
"summary": "Delete a checklist item"
|
|
1937
|
+
},
|
|
1938
|
+
{
|
|
1939
|
+
"route": "GET /api/v1/tasks/:id/comments",
|
|
1940
|
+
"scope": "tasks:read",
|
|
1941
|
+
"summary": "List task comments"
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"route": "POST /api/v1/tasks/:id/comments",
|
|
1945
|
+
"scope": "tasks:write",
|
|
1946
|
+
"summary": "Add a task comment"
|
|
1947
|
+
},
|
|
1948
|
+
{
|
|
1949
|
+
"route": "POST /api/v1/meetings",
|
|
1950
|
+
"scope": "meetings:write",
|
|
1951
|
+
"summary": "Create a meeting"
|
|
1952
|
+
},
|
|
1953
|
+
{
|
|
1954
|
+
"route": "GET /api/v1/meetings/week",
|
|
1955
|
+
"scope": "meetings:read",
|
|
1956
|
+
"summary": "List meetings in a calendar week"
|
|
1957
|
+
},
|
|
1958
|
+
{
|
|
1959
|
+
"route": "GET /api/v1/meetings/contact/:contactId",
|
|
1960
|
+
"scope": "meetings:read",
|
|
1961
|
+
"summary": "List meetings for a contact"
|
|
1962
|
+
},
|
|
1963
|
+
{
|
|
1964
|
+
"route": "GET /api/v1/meetings/:id",
|
|
1965
|
+
"scope": "meetings:read",
|
|
1966
|
+
"summary": "Get a meeting"
|
|
1967
|
+
},
|
|
1968
|
+
{
|
|
1969
|
+
"route": "PUT /api/v1/meetings/:id",
|
|
1970
|
+
"scope": "meetings:write",
|
|
1971
|
+
"summary": "Update a meeting"
|
|
1972
|
+
},
|
|
1973
|
+
{
|
|
1974
|
+
"route": "DELETE /api/v1/meetings/:id",
|
|
1975
|
+
"scope": "meetings:write",
|
|
1976
|
+
"summary": "Delete a meeting"
|
|
1977
|
+
},
|
|
1978
|
+
{
|
|
1979
|
+
"route": "POST /api/v1/meetings/:id/complete",
|
|
1980
|
+
"scope": "meetings:write",
|
|
1981
|
+
"summary": "Mark a meeting completed"
|
|
1982
|
+
},
|
|
1983
|
+
{
|
|
1984
|
+
"route": "POST /api/v1/meetings/:id/cancel",
|
|
1985
|
+
"scope": "meetings:write",
|
|
1986
|
+
"summary": "Mark a meeting cancelled"
|
|
1987
|
+
},
|
|
1988
|
+
{
|
|
1989
|
+
"route": "GET /api/v1/knowledge-center/categories",
|
|
1990
|
+
"scope": "knowledge:read",
|
|
1991
|
+
"summary": "List knowledge categories"
|
|
1992
|
+
},
|
|
1993
|
+
{
|
|
1994
|
+
"route": "POST /api/v1/knowledge-center/categories",
|
|
1995
|
+
"scope": "knowledge:write",
|
|
1996
|
+
"summary": "Create a knowledge category"
|
|
1997
|
+
},
|
|
1998
|
+
{
|
|
1999
|
+
"route": "PUT /api/v1/knowledge-center/categories/:id",
|
|
2000
|
+
"scope": "knowledge:write",
|
|
2001
|
+
"summary": "Update a knowledge category"
|
|
2002
|
+
},
|
|
2003
|
+
{
|
|
2004
|
+
"route": "DELETE /api/v1/knowledge-center/categories/:id",
|
|
2005
|
+
"scope": "knowledge:write",
|
|
2006
|
+
"summary": "Delete a knowledge category"
|
|
2007
|
+
},
|
|
2008
|
+
{
|
|
2009
|
+
"route": "PUT /api/v1/knowledge-center/categories/reorder",
|
|
2010
|
+
"scope": "knowledge:write",
|
|
2011
|
+
"summary": "Reorder knowledge categories"
|
|
2012
|
+
},
|
|
2013
|
+
{
|
|
2014
|
+
"route": "GET /api/v1/knowledge-center/articles",
|
|
2015
|
+
"scope": "knowledge:read",
|
|
2016
|
+
"summary": "List knowledge articles"
|
|
2017
|
+
},
|
|
2018
|
+
{
|
|
2019
|
+
"route": "POST /api/v1/knowledge-center/articles",
|
|
2020
|
+
"scope": "knowledge:write",
|
|
2021
|
+
"summary": "Create a knowledge article"
|
|
2022
|
+
},
|
|
2023
|
+
{
|
|
2024
|
+
"route": "GET /api/v1/knowledge-center/articles/:id",
|
|
2025
|
+
"scope": "knowledge:read",
|
|
2026
|
+
"summary": "Get a knowledge article"
|
|
2027
|
+
},
|
|
2028
|
+
{
|
|
2029
|
+
"route": "PUT /api/v1/knowledge-center/articles/:id",
|
|
2030
|
+
"scope": "knowledge:write",
|
|
2031
|
+
"summary": "Update a knowledge article"
|
|
2032
|
+
},
|
|
2033
|
+
{
|
|
2034
|
+
"route": "DELETE /api/v1/knowledge-center/articles/:id",
|
|
2035
|
+
"scope": "knowledge:write",
|
|
2036
|
+
"summary": "Delete a knowledge article"
|
|
2037
|
+
},
|
|
2038
|
+
{
|
|
2039
|
+
"route": "POST /api/v1/knowledge-center/articles/:id/publish",
|
|
2040
|
+
"scope": "knowledge:write",
|
|
2041
|
+
"summary": "Publish a knowledge article"
|
|
2042
|
+
},
|
|
2043
|
+
{
|
|
2044
|
+
"route": "POST /api/v1/knowledge-center/articles/:id/archive",
|
|
2045
|
+
"scope": "knowledge:write",
|
|
2046
|
+
"summary": "Archive a knowledge article"
|
|
2047
|
+
},
|
|
2048
|
+
{
|
|
2049
|
+
"route": "GET /api/v1/knowledge-center/search",
|
|
2050
|
+
"scope": "knowledge:read",
|
|
2051
|
+
"summary": "Search knowledge articles"
|
|
2052
|
+
},
|
|
2053
|
+
{
|
|
2054
|
+
"route": "GET /api/v1/knowledge-center/quick-search",
|
|
2055
|
+
"scope": "knowledge:read",
|
|
2056
|
+
"summary": "Quick-search knowledge articles"
|
|
2057
|
+
},
|
|
2058
|
+
{
|
|
2059
|
+
"route": "POST /api/v1/knowledge-center/articles/:id/feedback",
|
|
2060
|
+
"scope": "knowledge:write",
|
|
2061
|
+
"summary": "Submit article feedback"
|
|
2062
|
+
},
|
|
2063
|
+
{
|
|
2064
|
+
"route": "GET /api/v1/quick-replies",
|
|
2065
|
+
"scope": "library:read",
|
|
2066
|
+
"summary": "List quick replies"
|
|
2067
|
+
},
|
|
2068
|
+
{
|
|
2069
|
+
"route": "GET /api/v1/quick-replies/categories",
|
|
2070
|
+
"scope": "library:read",
|
|
2071
|
+
"summary": "List quick reply categories"
|
|
2072
|
+
},
|
|
2073
|
+
{
|
|
2074
|
+
"route": "POST /api/v1/quick-replies/categories/rename",
|
|
2075
|
+
"scope": "library:write",
|
|
2076
|
+
"summary": "Rename a quick reply category"
|
|
2077
|
+
},
|
|
2078
|
+
{
|
|
2079
|
+
"route": "POST /api/v1/quick-replies/categories/delete",
|
|
2080
|
+
"scope": "library:write",
|
|
2081
|
+
"summary": "Remove a category from its quick replies"
|
|
2082
|
+
},
|
|
2083
|
+
{
|
|
2084
|
+
"route": "GET /api/v1/quick-replies/:id",
|
|
2085
|
+
"scope": "library:read",
|
|
2086
|
+
"summary": "Get a quick reply"
|
|
2087
|
+
},
|
|
2088
|
+
{
|
|
2089
|
+
"route": "POST /api/v1/quick-replies",
|
|
2090
|
+
"scope": "library:write",
|
|
2091
|
+
"summary": "Create a quick reply"
|
|
2092
|
+
},
|
|
2093
|
+
{
|
|
2094
|
+
"route": "PUT /api/v1/quick-replies/:id",
|
|
2095
|
+
"scope": "library:write",
|
|
2096
|
+
"summary": "Update a quick reply"
|
|
2097
|
+
},
|
|
2098
|
+
{
|
|
2099
|
+
"route": "DELETE /api/v1/quick-replies/:id",
|
|
2100
|
+
"scope": "library:write",
|
|
2101
|
+
"summary": "Delete a quick reply"
|
|
2102
|
+
},
|
|
2103
|
+
{
|
|
2104
|
+
"route": "POST /api/v1/quick-replies/:id/use",
|
|
2105
|
+
"scope": "library:write",
|
|
2106
|
+
"summary": "Record quick reply usage"
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
"route": "GET /api/v1/saved-contacts",
|
|
2110
|
+
"scope": "library:read",
|
|
2111
|
+
"summary": "List saved contacts"
|
|
2112
|
+
},
|
|
2113
|
+
{
|
|
2114
|
+
"route": "GET /api/v1/saved-contacts/categories",
|
|
2115
|
+
"scope": "library:read",
|
|
2116
|
+
"summary": "List saved contact categories"
|
|
2117
|
+
},
|
|
2118
|
+
{
|
|
2119
|
+
"route": "GET /api/v1/saved-contacts/:id",
|
|
2120
|
+
"scope": "library:read",
|
|
2121
|
+
"summary": "Get a saved contact"
|
|
2122
|
+
},
|
|
2123
|
+
{
|
|
2124
|
+
"route": "GET /api/v1/saved-contacts/:id/whatsapp",
|
|
2125
|
+
"scope": "library:read",
|
|
2126
|
+
"summary": "Get a saved contact in WhatsApp vCard format"
|
|
2127
|
+
},
|
|
2128
|
+
{
|
|
2129
|
+
"route": "POST /api/v1/saved-contacts",
|
|
2130
|
+
"scope": "library:write",
|
|
2131
|
+
"summary": "Create a saved contact"
|
|
2132
|
+
},
|
|
2133
|
+
{
|
|
2134
|
+
"route": "PUT /api/v1/saved-contacts/:id",
|
|
2135
|
+
"scope": "library:write",
|
|
2136
|
+
"summary": "Update a saved contact"
|
|
2137
|
+
},
|
|
2138
|
+
{
|
|
2139
|
+
"route": "DELETE /api/v1/saved-contacts/:id",
|
|
2140
|
+
"scope": "library:write",
|
|
2141
|
+
"summary": "Delete a saved contact"
|
|
2142
|
+
},
|
|
2143
|
+
{
|
|
2144
|
+
"route": "POST /api/v1/saved-contacts/:id/use",
|
|
2145
|
+
"scope": "library:write",
|
|
2146
|
+
"summary": "Record saved contact usage"
|
|
2147
|
+
},
|
|
2148
|
+
{
|
|
2149
|
+
"route": "GET /api/v1/saved-locations",
|
|
2150
|
+
"scope": "library:read",
|
|
2151
|
+
"summary": "List saved locations"
|
|
2152
|
+
},
|
|
2153
|
+
{
|
|
2154
|
+
"route": "GET /api/v1/saved-locations/categories",
|
|
2155
|
+
"scope": "library:read",
|
|
2156
|
+
"summary": "List saved location categories"
|
|
2157
|
+
},
|
|
2158
|
+
{
|
|
2159
|
+
"route": "GET /api/v1/saved-locations/:id",
|
|
2160
|
+
"scope": "library:read",
|
|
2161
|
+
"summary": "Get a saved location"
|
|
2162
|
+
},
|
|
2163
|
+
{
|
|
2164
|
+
"route": "GET /api/v1/saved-locations/:id/whatsapp",
|
|
2165
|
+
"scope": "library:read",
|
|
2166
|
+
"summary": "Get a saved location in WhatsApp location format"
|
|
2167
|
+
},
|
|
2168
|
+
{
|
|
2169
|
+
"route": "POST /api/v1/saved-locations",
|
|
2170
|
+
"scope": "library:write",
|
|
2171
|
+
"summary": "Create a saved location"
|
|
2172
|
+
},
|
|
2173
|
+
{
|
|
2174
|
+
"route": "PUT /api/v1/saved-locations/:id",
|
|
2175
|
+
"scope": "library:write",
|
|
2176
|
+
"summary": "Update a saved location"
|
|
2177
|
+
},
|
|
2178
|
+
{
|
|
2179
|
+
"route": "DELETE /api/v1/saved-locations/:id",
|
|
2180
|
+
"scope": "library:write",
|
|
2181
|
+
"summary": "Delete a saved location"
|
|
2182
|
+
},
|
|
2183
|
+
{
|
|
2184
|
+
"route": "POST /api/v1/saved-locations/:id/use",
|
|
2185
|
+
"scope": "library:write",
|
|
2186
|
+
"summary": "Record saved location usage"
|
|
2187
|
+
},
|
|
2188
|
+
{
|
|
2189
|
+
"route": "GET /api/v1/media",
|
|
2190
|
+
"scope": "library:read",
|
|
2191
|
+
"summary": "List media library files"
|
|
2192
|
+
},
|
|
2193
|
+
{
|
|
2194
|
+
"route": "GET /api/v1/media/stats",
|
|
2195
|
+
"scope": "library:read",
|
|
2196
|
+
"summary": "Get media library stats"
|
|
2197
|
+
},
|
|
2198
|
+
{
|
|
2199
|
+
"route": "GET /api/v1/media/:id",
|
|
2200
|
+
"scope": "library:read",
|
|
2201
|
+
"summary": "Get a media file"
|
|
2202
|
+
},
|
|
2203
|
+
{
|
|
2204
|
+
"route": "GET /api/v1/media/limits",
|
|
2205
|
+
"scope": "library:read",
|
|
2206
|
+
"summary": "Per-channel accepted file types and sizes"
|
|
2207
|
+
},
|
|
2208
|
+
{
|
|
2209
|
+
"route": "GET /api/v1/media/:id/usage",
|
|
2210
|
+
"scope": "library:read",
|
|
2211
|
+
"summary": "Where a media file is used"
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"route": "PUT /api/v1/media/:id",
|
|
2215
|
+
"scope": "library:write",
|
|
2216
|
+
"summary": "Rename a media file or set its AI-accessibility"
|
|
2217
|
+
},
|
|
2218
|
+
{
|
|
2219
|
+
"route": "DELETE /api/v1/media/:id",
|
|
2220
|
+
"scope": "library:write",
|
|
2221
|
+
"summary": "Delete a media file (409 MEDIA_IN_USE unless ?force=true)"
|
|
2222
|
+
},
|
|
2223
|
+
{
|
|
2224
|
+
"route": "POST /api/v1/media/bulk-delete",
|
|
2225
|
+
"scope": "library:write",
|
|
2226
|
+
"summary": "Bulk delete media files"
|
|
2227
|
+
},
|
|
2228
|
+
{
|
|
2229
|
+
"route": "POST /api/v1/media/:id/use",
|
|
2230
|
+
"scope": "library:write",
|
|
2231
|
+
"summary": "Record media file usage"
|
|
2232
|
+
},
|
|
2233
|
+
{
|
|
2234
|
+
"route": "GET /api/v1/leads/pipeline",
|
|
2235
|
+
"scope": "leads:read",
|
|
2236
|
+
"summary": "Get the lead pipeline"
|
|
2237
|
+
},
|
|
2238
|
+
{
|
|
2239
|
+
"route": "GET /api/v1/leads/statuses",
|
|
2240
|
+
"scope": "leads:read",
|
|
2241
|
+
"summary": "List lead statuses"
|
|
2242
|
+
},
|
|
2243
|
+
{
|
|
2244
|
+
"route": "GET /api/v1/leads/stats",
|
|
2245
|
+
"scope": "leads:read",
|
|
2246
|
+
"summary": "Get lead pipeline stats"
|
|
2247
|
+
},
|
|
2248
|
+
{
|
|
2249
|
+
"route": "GET /api/v1/leads/list",
|
|
2250
|
+
"scope": "leads:read",
|
|
2251
|
+
"summary": "List leads (paginated table view)"
|
|
2252
|
+
},
|
|
2253
|
+
{
|
|
2254
|
+
"route": "POST /api/v1/leads/suggest",
|
|
2255
|
+
"scope": "leads:write",
|
|
2256
|
+
"summary": "AI-suggest lead fields from a conversation"
|
|
2257
|
+
},
|
|
2258
|
+
{
|
|
2259
|
+
"route": "POST /api/v1/leads/statuses",
|
|
2260
|
+
"scope": "leads:write",
|
|
2261
|
+
"summary": "Create a lead status"
|
|
2262
|
+
},
|
|
2263
|
+
{
|
|
2264
|
+
"route": "PATCH /api/v1/leads/statuses/reorder",
|
|
2265
|
+
"scope": "leads:write",
|
|
2266
|
+
"summary": "Reorder lead statuses"
|
|
2267
|
+
},
|
|
2268
|
+
{
|
|
2269
|
+
"route": "PATCH /api/v1/leads/statuses/:statusId",
|
|
2270
|
+
"scope": "leads:write",
|
|
2271
|
+
"summary": "Update a lead status"
|
|
2272
|
+
},
|
|
2273
|
+
{
|
|
2274
|
+
"route": "DELETE /api/v1/leads/statuses/:statusId",
|
|
2275
|
+
"scope": "leads:write",
|
|
2276
|
+
"summary": "Delete a lead status"
|
|
2277
|
+
},
|
|
2278
|
+
{
|
|
2279
|
+
"route": "POST /api/v1/leads/:id/move",
|
|
2280
|
+
"scope": "leads:write",
|
|
2281
|
+
"summary": "Move a lead to a stage"
|
|
2282
|
+
},
|
|
2283
|
+
{
|
|
2284
|
+
"route": "POST /api/v1/leads/:id/win",
|
|
2285
|
+
"scope": "leads:write",
|
|
2286
|
+
"summary": "Mark a lead won"
|
|
2287
|
+
},
|
|
2288
|
+
{
|
|
2289
|
+
"route": "POST /api/v1/leads/:id/lose",
|
|
2290
|
+
"scope": "leads:write",
|
|
2291
|
+
"summary": "Mark a lead lost"
|
|
2292
|
+
},
|
|
2293
|
+
{
|
|
2294
|
+
"route": "POST /api/v1/leads/:id/assign",
|
|
2295
|
+
"scope": "leads:write",
|
|
2296
|
+
"summary": "Assign a lead"
|
|
2297
|
+
},
|
|
2298
|
+
{
|
|
2299
|
+
"route": "PATCH /api/v1/leads/:id/status",
|
|
2300
|
+
"scope": "leads:write",
|
|
2301
|
+
"summary": "Set lead status"
|
|
2302
|
+
},
|
|
2303
|
+
{
|
|
2304
|
+
"route": "PATCH /api/v1/leads/:id/rating",
|
|
2305
|
+
"scope": "leads:write",
|
|
2306
|
+
"summary": "Set lead star rating"
|
|
2307
|
+
},
|
|
2308
|
+
{
|
|
2309
|
+
"route": "PATCH /api/v1/leads/:id/priority",
|
|
2310
|
+
"scope": "leads:write",
|
|
2311
|
+
"summary": "Set lead priority"
|
|
2312
|
+
},
|
|
2313
|
+
{
|
|
2314
|
+
"route": "GET /api/v1/leads/:id/feedback",
|
|
2315
|
+
"scope": "leads:read",
|
|
2316
|
+
"summary": "List the feedback thread on a lead"
|
|
2317
|
+
},
|
|
2318
|
+
{
|
|
2319
|
+
"route": "POST /api/v1/leads/:id/feedback",
|
|
2320
|
+
"scope": "leads:write",
|
|
2321
|
+
"summary": "Add a lead feedback entry"
|
|
2322
|
+
},
|
|
2323
|
+
{
|
|
2324
|
+
"route": "POST /api/v1/leads/:id/follow-up",
|
|
2325
|
+
"scope": "leads:write",
|
|
2326
|
+
"summary": "Schedule a lead follow-up task"
|
|
2327
|
+
},
|
|
2328
|
+
{
|
|
2329
|
+
"route": "GET /api/v1/leads/:id/follow-ups",
|
|
2330
|
+
"scope": "leads:read",
|
|
2331
|
+
"summary": "List lead follow-up tasks"
|
|
2332
|
+
},
|
|
2333
|
+
{
|
|
2334
|
+
"route": "GET /api/v1/leads/:id",
|
|
2335
|
+
"scope": "leads:read",
|
|
2336
|
+
"summary": "Get a lead"
|
|
2337
|
+
},
|
|
2338
|
+
{
|
|
2339
|
+
"route": "GET /api/v1/tickets",
|
|
2340
|
+
"scope": "tickets:read",
|
|
2341
|
+
"summary": "List tickets"
|
|
2342
|
+
},
|
|
2343
|
+
{
|
|
2344
|
+
"route": "GET /api/v1/tickets/stats",
|
|
2345
|
+
"scope": "tickets:read",
|
|
2346
|
+
"summary": "Get ticket stats"
|
|
2347
|
+
},
|
|
2348
|
+
{
|
|
2349
|
+
"route": "GET /api/v1/tickets/my",
|
|
2350
|
+
"scope": "tickets:read",
|
|
2351
|
+
"summary": "List tickets assigned to the token owner"
|
|
2352
|
+
},
|
|
2353
|
+
{
|
|
2354
|
+
"route": "GET /api/v1/tickets/contact/:contactId",
|
|
2355
|
+
"scope": "tickets:read",
|
|
2356
|
+
"summary": "List tickets for a contact"
|
|
2357
|
+
},
|
|
2358
|
+
{
|
|
2359
|
+
"route": "GET /api/v1/tickets/types",
|
|
2360
|
+
"scope": "tickets:read",
|
|
2361
|
+
"summary": "List ticket types"
|
|
2362
|
+
},
|
|
2363
|
+
{
|
|
2364
|
+
"route": "POST /api/v1/tickets/types",
|
|
2365
|
+
"scope": "tickets:write",
|
|
2366
|
+
"summary": "Create a ticket type"
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"route": "PUT /api/v1/tickets/types/:typeId",
|
|
2370
|
+
"scope": "tickets:write",
|
|
2371
|
+
"summary": "Update a ticket type"
|
|
2372
|
+
},
|
|
2373
|
+
{
|
|
2374
|
+
"route": "DELETE /api/v1/tickets/types/:typeId",
|
|
2375
|
+
"scope": "tickets:write",
|
|
2376
|
+
"summary": "Delete a ticket type"
|
|
2377
|
+
},
|
|
2378
|
+
{
|
|
2379
|
+
"route": "POST /api/v1/tickets",
|
|
2380
|
+
"scope": "tickets:write",
|
|
2381
|
+
"summary": "Create a ticket"
|
|
2382
|
+
},
|
|
2383
|
+
{
|
|
2384
|
+
"route": "GET /api/v1/tickets/:id",
|
|
2385
|
+
"scope": "tickets:read",
|
|
2386
|
+
"summary": "Get a ticket"
|
|
2387
|
+
},
|
|
2388
|
+
{
|
|
2389
|
+
"route": "PUT /api/v1/tickets/:id",
|
|
2390
|
+
"scope": "tickets:write",
|
|
2391
|
+
"summary": "Update a ticket"
|
|
2392
|
+
},
|
|
2393
|
+
{
|
|
2394
|
+
"route": "DELETE /api/v1/tickets/:id",
|
|
2395
|
+
"scope": "tickets:write",
|
|
2396
|
+
"summary": "Delete a ticket"
|
|
2397
|
+
},
|
|
2398
|
+
{
|
|
2399
|
+
"route": "PATCH /api/v1/tickets/:id/status",
|
|
2400
|
+
"scope": "tickets:write",
|
|
2401
|
+
"summary": "Change ticket status"
|
|
2402
|
+
},
|
|
2403
|
+
{
|
|
2404
|
+
"route": "POST /api/v1/tickets/:id/assign",
|
|
2405
|
+
"scope": "tickets:write",
|
|
2406
|
+
"summary": "Assign a ticket"
|
|
2407
|
+
},
|
|
2408
|
+
{
|
|
2409
|
+
"route": "POST /api/v1/tickets/:id/close",
|
|
2410
|
+
"scope": "tickets:write",
|
|
2411
|
+
"summary": "Close a ticket"
|
|
2412
|
+
},
|
|
2413
|
+
{
|
|
2414
|
+
"route": "GET /api/v1/tickets/:id/comments",
|
|
2415
|
+
"scope": "tickets:read",
|
|
2416
|
+
"summary": "List ticket comments"
|
|
2417
|
+
},
|
|
2418
|
+
{
|
|
2419
|
+
"route": "POST /api/v1/tickets/:id/comments",
|
|
2420
|
+
"scope": "tickets:write",
|
|
2421
|
+
"summary": "Comment on a ticket"
|
|
2422
|
+
},
|
|
2423
|
+
{
|
|
2424
|
+
"route": "GET /api/v1/tickets/:id/attachments",
|
|
2425
|
+
"scope": "tickets:read",
|
|
2426
|
+
"summary": "List ticket attachments"
|
|
2427
|
+
},
|
|
2428
|
+
{
|
|
2429
|
+
"route": "POST /api/v1/tickets/:id/attachments",
|
|
2430
|
+
"scope": "tickets:write",
|
|
2431
|
+
"summary": "Add a ticket attachment (URL reference, not an upload)"
|
|
2432
|
+
},
|
|
2433
|
+
{
|
|
2434
|
+
"route": "DELETE /api/v1/tickets/attachments/:attachmentId",
|
|
2435
|
+
"scope": "tickets:write",
|
|
2436
|
+
"summary": "Delete a ticket attachment"
|
|
2437
|
+
},
|
|
2438
|
+
{
|
|
2439
|
+
"route": "GET /api/v1/tickets/:id/activity",
|
|
2440
|
+
"scope": "tickets:read",
|
|
2441
|
+
"summary": "Get the ticket audit trail"
|
|
2442
|
+
},
|
|
2443
|
+
{
|
|
2444
|
+
"route": "POST /api/v1/orders",
|
|
2445
|
+
"scope": "orders:write",
|
|
2446
|
+
"summary": "Create an order"
|
|
2447
|
+
},
|
|
2448
|
+
{
|
|
2449
|
+
"route": "PUT /api/v1/orders/:id",
|
|
2450
|
+
"scope": "orders:write",
|
|
2451
|
+
"summary": "Update an order"
|
|
2452
|
+
},
|
|
2453
|
+
{
|
|
2454
|
+
"route": "PATCH /api/v1/orders/:id/status",
|
|
2455
|
+
"scope": "orders:write",
|
|
2456
|
+
"summary": "Change order status"
|
|
2457
|
+
},
|
|
2458
|
+
{
|
|
2459
|
+
"route": "PATCH /api/v1/orders/:id/payment",
|
|
2460
|
+
"scope": "orders:write",
|
|
2461
|
+
"summary": "Change payment status"
|
|
2462
|
+
},
|
|
2463
|
+
{
|
|
2464
|
+
"route": "PATCH /api/v1/orders/:id/fulfillment",
|
|
2465
|
+
"scope": "orders:write",
|
|
2466
|
+
"summary": "Change fulfillment status"
|
|
2467
|
+
},
|
|
2468
|
+
{
|
|
2469
|
+
"route": "GET /api/v1/products/categories",
|
|
2470
|
+
"scope": "products:read",
|
|
2471
|
+
"summary": "List product categories"
|
|
2472
|
+
},
|
|
2473
|
+
{
|
|
2474
|
+
"route": "POST /api/v1/products",
|
|
2475
|
+
"scope": "products:write",
|
|
2476
|
+
"summary": "Create a product"
|
|
2477
|
+
},
|
|
2478
|
+
{
|
|
2479
|
+
"route": "PUT /api/v1/products/:id",
|
|
2480
|
+
"scope": "products:write",
|
|
2481
|
+
"summary": "Update a product"
|
|
2482
|
+
},
|
|
2483
|
+
{
|
|
2484
|
+
"route": "DELETE /api/v1/products/:id",
|
|
2485
|
+
"scope": "products:write",
|
|
2486
|
+
"summary": "Delete a product"
|
|
2487
|
+
},
|
|
2488
|
+
{
|
|
2489
|
+
"route": "POST /api/v1/products/categories",
|
|
2490
|
+
"scope": "products:write",
|
|
2491
|
+
"summary": "Create a product category"
|
|
2492
|
+
},
|
|
2493
|
+
{
|
|
2494
|
+
"route": "GET /api/v1/webhooks/events",
|
|
2495
|
+
"scope": "webhooks:read",
|
|
2496
|
+
"summary": "List webhook event types"
|
|
2497
|
+
},
|
|
2498
|
+
{
|
|
2499
|
+
"route": "GET /api/v1/webhooks",
|
|
2500
|
+
"scope": "webhooks:read",
|
|
2501
|
+
"summary": "List webhooks"
|
|
2502
|
+
},
|
|
2503
|
+
{
|
|
2504
|
+
"route": "GET /api/v1/webhooks/:webhookId",
|
|
2505
|
+
"scope": "webhooks:read",
|
|
2506
|
+
"summary": "Get a webhook"
|
|
2507
|
+
},
|
|
2508
|
+
{
|
|
2509
|
+
"route": "GET /api/v1/webhooks/:webhookId/logs",
|
|
2510
|
+
"scope": "webhooks:read",
|
|
2511
|
+
"summary": "List webhook deliveries"
|
|
2512
|
+
},
|
|
2513
|
+
{
|
|
2514
|
+
"route": "POST /api/v1/webhooks",
|
|
2515
|
+
"scope": "webhooks:write",
|
|
2516
|
+
"summary": "Register a webhook"
|
|
2517
|
+
},
|
|
2518
|
+
{
|
|
2519
|
+
"route": "PUT /api/v1/webhooks/:webhookId",
|
|
2520
|
+
"scope": "webhooks:write",
|
|
2521
|
+
"summary": "Update a webhook"
|
|
2522
|
+
},
|
|
2523
|
+
{
|
|
2524
|
+
"route": "DELETE /api/v1/webhooks/:webhookId",
|
|
2525
|
+
"scope": "webhooks:write",
|
|
2526
|
+
"summary": "Delete a webhook"
|
|
2527
|
+
},
|
|
2528
|
+
{
|
|
2529
|
+
"route": "POST /api/v1/webhooks/:webhookId/test",
|
|
2530
|
+
"scope": "webhooks:write",
|
|
2531
|
+
"summary": "Send a test delivery"
|
|
2532
|
+
},
|
|
2533
|
+
{
|
|
2534
|
+
"route": "GET /api/v1/webhooks/:webhookId/secret",
|
|
2535
|
+
"scope": "webhooks:write",
|
|
2536
|
+
"summary": "Reveal the signing secret (to verify X-Inboxy-Signature)"
|
|
2537
|
+
},
|
|
2538
|
+
{
|
|
2539
|
+
"route": "POST /api/v1/webhooks/:webhookId/regenerate-secret",
|
|
2540
|
+
"scope": "webhooks:write",
|
|
2541
|
+
"summary": "Rotate the signing secret"
|
|
2542
|
+
},
|
|
2543
|
+
{
|
|
2544
|
+
"route": "POST /api/v1/webhooks/:webhookId/replay",
|
|
2545
|
+
"scope": "webhooks:write",
|
|
2546
|
+
"summary": "Redeliver the failed deliveries of the last 7 days"
|
|
2547
|
+
},
|
|
2548
|
+
{
|
|
2549
|
+
"route": "GET /api/v1/team",
|
|
2550
|
+
"scope": "team:read",
|
|
2551
|
+
"summary": "List team members"
|
|
2552
|
+
},
|
|
2553
|
+
{
|
|
2554
|
+
"route": "GET /api/v1/team/:userId",
|
|
2555
|
+
"scope": "team:read",
|
|
2556
|
+
"summary": "Get a team member"
|
|
2557
|
+
},
|
|
2558
|
+
{
|
|
2559
|
+
"route": "GET /api/v1/team/stats",
|
|
2560
|
+
"scope": "team:read",
|
|
2561
|
+
"summary": "Get team headcount and role breakdown"
|
|
2562
|
+
},
|
|
2563
|
+
{
|
|
2564
|
+
"route": "GET /api/v1/company",
|
|
2565
|
+
"scope": "team:read",
|
|
2566
|
+
"summary": "Get company profile and settings"
|
|
2567
|
+
},
|
|
2568
|
+
{
|
|
2569
|
+
"route": "GET /api/v1/csat/config",
|
|
2570
|
+
"scope": "analytics:read",
|
|
2571
|
+
"summary": "Get the CSAT survey config"
|
|
2572
|
+
},
|
|
2573
|
+
{
|
|
2574
|
+
"route": "GET /api/v1/csat/analytics",
|
|
2575
|
+
"scope": "analytics:read",
|
|
2576
|
+
"summary": "Get CSAT analytics for a period"
|
|
2577
|
+
},
|
|
2578
|
+
{
|
|
2579
|
+
"route": "PUT /api/v1/ai-agents/:agentId/channels",
|
|
2580
|
+
"scope": "ai:write",
|
|
2581
|
+
"summary": "Configure employee channel assignments"
|
|
2582
|
+
},
|
|
2583
|
+
{
|
|
2584
|
+
"route": "POST /api/v1/ai-agents/:agentId/knowledge",
|
|
2585
|
+
"scope": "ai:write",
|
|
2586
|
+
"summary": "Create employee text knowledge"
|
|
2587
|
+
},
|
|
2588
|
+
{
|
|
2589
|
+
"route": "PUT /api/v1/ai-agents/:agentId/knowledge/:knowledgeId",
|
|
2590
|
+
"scope": "ai:write",
|
|
2591
|
+
"summary": "Update employee knowledge"
|
|
2592
|
+
},
|
|
2593
|
+
{
|
|
2594
|
+
"route": "GET /api/v1/ai-agents/channels",
|
|
2595
|
+
"scope": "ai:read",
|
|
2596
|
+
"summary": "List channels available for agent assignment"
|
|
2597
|
+
},
|
|
2598
|
+
{
|
|
2599
|
+
"route": "GET /api/v1/ai-agents/presets/personalities",
|
|
2600
|
+
"scope": "ai:read",
|
|
2601
|
+
"summary": "List agent personality presets"
|
|
2602
|
+
},
|
|
2603
|
+
{
|
|
2604
|
+
"route": "GET /api/v1/ai-agents/presets/agent-types",
|
|
2605
|
+
"scope": "ai:read",
|
|
2606
|
+
"summary": "List agent type presets"
|
|
2607
|
+
},
|
|
2608
|
+
{
|
|
2609
|
+
"route": "GET /api/v1/ai-agents",
|
|
2610
|
+
"scope": "ai:read",
|
|
2611
|
+
"summary": "List AI agents"
|
|
2612
|
+
},
|
|
2613
|
+
{
|
|
2614
|
+
"route": "GET /api/v1/ai-agents/stats",
|
|
2615
|
+
"scope": "ai:read",
|
|
2616
|
+
"summary": "Get AI agent stats"
|
|
2617
|
+
},
|
|
2618
|
+
{
|
|
2619
|
+
"route": "GET /api/v1/ai-agents/insights/schedule",
|
|
2620
|
+
"scope": "ai:read",
|
|
2621
|
+
"summary": "Get the conversation insights schedule"
|
|
2622
|
+
},
|
|
2623
|
+
{
|
|
2624
|
+
"route": "PUT /api/v1/ai-agents/insights/schedule",
|
|
2625
|
+
"scope": "ai:write",
|
|
2626
|
+
"summary": "Set the conversation insights schedule"
|
|
2627
|
+
},
|
|
2628
|
+
{
|
|
2629
|
+
"route": "GET /api/v1/ai-agents/insights/reports",
|
|
2630
|
+
"scope": "ai:read",
|
|
2631
|
+
"summary": "List conversation insight reports"
|
|
2632
|
+
},
|
|
2633
|
+
{
|
|
2634
|
+
"route": "GET /api/v1/ai-agents/insights/reports/:reportId",
|
|
2635
|
+
"scope": "ai:read",
|
|
2636
|
+
"summary": "Get a conversation insight report"
|
|
2637
|
+
},
|
|
2638
|
+
{
|
|
2639
|
+
"route": "POST /api/v1/ai-agents/insights/run",
|
|
2640
|
+
"scope": "ai:write",
|
|
2641
|
+
"summary": "Queue a manual conversation insight report"
|
|
2642
|
+
},
|
|
2643
|
+
{
|
|
2644
|
+
"route": "GET /api/v1/ai-agents/historical-learning",
|
|
2645
|
+
"scope": "ai:read",
|
|
2646
|
+
"summary": "List historical learning profiles"
|
|
2647
|
+
},
|
|
2648
|
+
{
|
|
2649
|
+
"route": "PUT /api/v1/ai-agents/:agentId/historical-learning",
|
|
2650
|
+
"scope": "ai:write",
|
|
2651
|
+
"summary": "Enable or disable historical learning for an agent"
|
|
2652
|
+
},
|
|
2653
|
+
{
|
|
2654
|
+
"route": "POST /api/v1/ai-agents/:agentId/historical-learning/run",
|
|
2655
|
+
"scope": "ai:write",
|
|
2656
|
+
"summary": "Run historical learning analysis for an agent"
|
|
2657
|
+
},
|
|
2658
|
+
{
|
|
2659
|
+
"route": "POST /api/v1/ai-agents/drafts",
|
|
2660
|
+
"scope": "ai:write",
|
|
2661
|
+
"summary": "Create or resume an inactive AI draft"
|
|
2662
|
+
},
|
|
2663
|
+
{
|
|
2664
|
+
"route": "POST /api/v1/ai-agents/:agentId/test",
|
|
2665
|
+
"scope": "ai:write",
|
|
2666
|
+
"summary": "Test an AI employee without customer messages"
|
|
2667
|
+
},
|
|
2668
|
+
{
|
|
2669
|
+
"route": "POST /api/v1/ai-agents/:agentId/setup-test",
|
|
2670
|
+
"scope": "ai:write",
|
|
2671
|
+
"summary": "Check AI employee readiness"
|
|
2672
|
+
},
|
|
2673
|
+
{
|
|
2674
|
+
"route": "POST /api/v1/ai-agents/:agentId/publish",
|
|
2675
|
+
"scope": "ai:write",
|
|
2676
|
+
"summary": "Activate AI employee on selected channels"
|
|
2677
|
+
},
|
|
2678
|
+
{
|
|
2679
|
+
"route": "POST /api/v1/ai-agents",
|
|
2680
|
+
"scope": "ai:write",
|
|
2681
|
+
"summary": "Create an AI agent"
|
|
2682
|
+
},
|
|
2683
|
+
{
|
|
2684
|
+
"route": "GET /api/v1/ai-agents/:agentId",
|
|
2685
|
+
"scope": "ai:read",
|
|
2686
|
+
"summary": "Get an AI agent"
|
|
2687
|
+
},
|
|
2688
|
+
{
|
|
2689
|
+
"route": "PUT /api/v1/ai-agents/:agentId",
|
|
2690
|
+
"scope": "ai:write",
|
|
2691
|
+
"summary": "Update an AI agent"
|
|
2692
|
+
},
|
|
2693
|
+
{
|
|
2694
|
+
"route": "DELETE /api/v1/ai-agents/:agentId",
|
|
2695
|
+
"scope": "ai:write",
|
|
2696
|
+
"summary": "Delete an AI agent"
|
|
2697
|
+
},
|
|
2698
|
+
{
|
|
2699
|
+
"route": "GET /api/v1/ai-agents/:agentId/knowledge",
|
|
2700
|
+
"scope": "ai:read",
|
|
2701
|
+
"summary": "List agent knowledge entries"
|
|
2702
|
+
},
|
|
2703
|
+
{
|
|
2704
|
+
"route": "GET /api/v1/ai-agents/:agentId/knowledge/categories",
|
|
2705
|
+
"scope": "ai:read",
|
|
2706
|
+
"summary": "List agent knowledge categories"
|
|
2707
|
+
},
|
|
2708
|
+
{
|
|
2709
|
+
"route": "GET /api/v1/ai-agents/:agentId/knowledge/:knowledgeId",
|
|
2710
|
+
"scope": "ai:read",
|
|
2711
|
+
"summary": "Get an agent knowledge entry"
|
|
2712
|
+
},
|
|
2713
|
+
{
|
|
2714
|
+
"route": "DELETE /api/v1/ai-agents/:agentId/knowledge/:knowledgeId",
|
|
2715
|
+
"scope": "ai:write",
|
|
2716
|
+
"summary": "Delete an agent knowledge entry"
|
|
2717
|
+
},
|
|
2718
|
+
{
|
|
2719
|
+
"route": "GET /api/v1/ai-agents/upload/info",
|
|
2720
|
+
"scope": "ai:read",
|
|
2721
|
+
"summary": "Get supported knowledge upload file types"
|
|
2722
|
+
},
|
|
2723
|
+
{
|
|
2724
|
+
"route": "GET /api/v1/ai-agents/logs",
|
|
2725
|
+
"scope": "ai:read",
|
|
2726
|
+
"summary": "List agent event logs"
|
|
2727
|
+
},
|
|
2728
|
+
{
|
|
2729
|
+
"route": "GET /api/v1/ai-agents/logs/stats",
|
|
2730
|
+
"scope": "ai:read",
|
|
2731
|
+
"summary": "Get agent log stats"
|
|
2732
|
+
},
|
|
2733
|
+
{
|
|
2734
|
+
"route": "GET /api/v1/ai-agents/functions/builtin",
|
|
2735
|
+
"scope": "ai:read",
|
|
2736
|
+
"summary": "List built-in agent functions"
|
|
2737
|
+
},
|
|
2738
|
+
{
|
|
2739
|
+
"route": "GET /api/v1/ai-agents/:agentId/functions",
|
|
2740
|
+
"scope": "ai:read",
|
|
2741
|
+
"summary": "List agent functions"
|
|
2742
|
+
},
|
|
2743
|
+
{
|
|
2744
|
+
"route": "POST /api/v1/ai-agents/:agentId/functions",
|
|
2745
|
+
"scope": "ai:write",
|
|
2746
|
+
"summary": "Create an agent function"
|
|
2747
|
+
},
|
|
2748
|
+
{
|
|
2749
|
+
"route": "PUT /api/v1/ai-agents/:agentId/functions/:functionId",
|
|
2750
|
+
"scope": "ai:write",
|
|
2751
|
+
"summary": "Update an agent function"
|
|
2752
|
+
},
|
|
2753
|
+
{
|
|
2754
|
+
"route": "DELETE /api/v1/ai-agents/:agentId/functions/:functionId",
|
|
2755
|
+
"scope": "ai:write",
|
|
2756
|
+
"summary": "Delete an agent function"
|
|
2757
|
+
},
|
|
2758
|
+
{
|
|
2759
|
+
"route": "PATCH /api/v1/ai-agents/:agentId/functions/:functionId/toggle",
|
|
2760
|
+
"scope": "ai:write",
|
|
2761
|
+
"summary": "Enable or disable an agent function"
|
|
2762
|
+
},
|
|
2763
|
+
{
|
|
2764
|
+
"route": "POST /api/v1/ai-agents/functions/sync",
|
|
2765
|
+
"scope": "ai:write",
|
|
2766
|
+
"summary": "Sync built-in functions to all agents"
|
|
2767
|
+
}
|
|
2768
|
+
];
|
|
2769
|
+
//# sourceMappingURL=api-route-inventory.generated.js.map
|