-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yml
19282 lines (19237 loc) · 638 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Brevo API
description: Brevo API documentation by XDEV Software based on https://api.brevo.com/v3/swagger_definition_v3.yml
license:
name: MIT
url: http://opensource.org/licenses/MIT
version: 3.0.0
externalDocs:
description: Brevo's API documentation
url: https://developers.brevo.com/reference
servers:
- url: https://api.brevo.com/v3
security:
- api-key: [ ]
paths:
/emailCampaigns:
get:
tags:
- Email Campaigns
summary: Return all your created email campaigns
operationId: getEmailCampaigns
parameters:
- name: type
in: query
description: Filter on the type of the campaigns
schema:
type: string
enum:
- classic
- trigger
- name: status
in: query
description: Filter on the status of the campaign
schema:
type: string
enum:
- suspended
- archive
- sent
- queued
- draft
- inProcess
- name: statistics
in: query
description: Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
schema:
type: string
enum:
- globalStats
- linksStats
- statsByDomain
- name: startDate
in: query
description: |
**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns.
**Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
schema:
type: string
- name: endDate
in: query
description: |
**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns.
**Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
schema:
type: string
- name: limit
in: query
description: Number of documents per page
schema:
maximum: 100
minimum: 0
type: integer
format: int64
default: 50
- name: offset
in: query
description: Index of the first document in the page
schema:
type: integer
format: int64
default: 0
- name: sort
in: query
description: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
required: false
schema:
type: string
default: desc
enum:
- asc
- desc
- name: excludeHtmlContent
in: query
description: Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body
schema:
type: boolean
enum:
- true
- false
responses:
200:
description: Email campaigns informations
content:
application/json:
schema:
$ref: '#/components/schemas/getEmailCampaigns'
examples:
response:
value:
count: 2
campaigns:
- id: 12
name: EN - Sales Summer 2017
subject: 20% OFF for 2017 Summer Sales
previewText: Don't miss the sale
type: classic
status: sent
scheduledAt: 2017-06-01T12:30:00Z
testSent: true
header: '[DEFAULT_HEADER]'
footer: '[DEFAULT_FOOTER]'
sender:
email: marketing@mycompany.com
name: Marketing
id: 26
replyTo: replyto@domain.com
toField: '{FNAME} {LNAME}'
htmlContent: This is my HTML Content
shareLink: http://example.com/fhsgccc.html?t=9865448900
tag: Newsletter
createdAt: 2017-05-01T12:30:00Z
modifiedAt: 2017-05-01T12:30:00Z
inlineImageActivation: true
mirrorActive: true
recurring: false
recipients:
lists:
- 5
exclusionLists:
- 13
statistics:
globalStats:
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
trackableViews: 5661
trackableViewsRate: 23.45
estimatedViews: 560
unsubscriptions: 2
viewed: 8999
campaignStats:
- listId: 5
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
trackableViews: 5661
unsubscriptions: 2
viewed: 8999
deferred: 30
mirrorClick: 120
remaining: 1000
linksStats:
http://myUrl1.domain.com: 80
statsByDomain:
yahoo.com:
uniqueClicks: 298
clickers: 533
complaints: 0
sent: 25601
softBounces: 5
hardBounces: 0
uniqueViews: 3527
unsubscriptions: 17
viewed: 5255
delivered: 25596
hotmail.co.uk:
uniqueClicks: 1970
clickers: 2720
complaints: 5
sent: 117055
softBounces: 111
hardBounces: 0
uniqueViews: 21111
unsubscriptions: 105
viewed: 35251
delivered: 117056
- id: 22
name: Weekly - 1
subject: Week 1 - Newsletter
previewText: your weekly newsletter
type: Classic
status: draft
scheduledAt: ""
testSent: false
header: '[DEFAULT_HEADER]'
footer: '[DEFAULT_FOOTER]'
sender:
email: newsletter@mycompany.com
name: Newsletter
id: 26
replyTo: replyto@domain.com
toField: '{FNAME} {LNAME}'
htmlContent: This is my HTML Content
shareLink: http://example.com/fhsgccc.html?t=9865448900
tag: Newsletter
createdAt: 2017-05-01T12:30:00Z
modifiedAt: 2017-05-01T12:30:00Z
inlineImageActivation: true
mirrorActive: true
recurring: false
recipients:
lists:
- 10
exclusionLists:
- 45
statistics:
globalStats:
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
trackableViews: 5661
trackableViewsRate: 23.45
estimatedViews: 560
unsubscriptions: 2
viewed: 8999
campaignStats:
- listId: 10
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
trackableViews: 5661
unsubscriptions: 2
viewed: 8999
deferred: 30
mirrorClick: 120
remaining: 1000
linksStats:
http://myUrl1.domain.com:
nbClick: 80
http://myUrl2.domain.com:
nbClick: 80
http://myUrl3.domain.com:
nbClick: 80
statsByDomain:
gmail:
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
unsubscriptions: 2
viewed: 8999
deferred: 30
aol:
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
unsubscriptions: 2
viewed: 8999
deferred: 30
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
post:
tags:
- Email Campaigns
summary: Create an email campaign
operationId: createEmailCampaign
requestBody:
description: Values to create a campaign
content:
application/json:
schema:
$ref: '#/components/schemas/createEmailCampaign'
required: true
responses:
201:
$ref: '#/components/responses/createModel'
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/emailCampaigns/{campaignId}:
get:
tags:
- Email Campaigns
summary: Get an email campaign report
operationId: getEmailCampaign
parameters:
- name: campaignId
in: path
description: Id of the campaign
required: true
schema:
type: integer
format: int64
- name: statistics
in: query
description: Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
required: false
schema:
type: string
enum:
- globalStats
- linksStats
- statsByDomain
- statsByDevice
- statsByBrowser
responses:
200:
description: Email campaign informations
content:
application/json:
schema:
$ref: '#/components/schemas/getEmailCampaign'
examples:
response:
value:
id: 22
name: Weekly - 1
subject: Week 1 - Newsletter
previewText: your weekly newsletter!
type: classic
status: draft
scheduledAt: 2017-09-22T12:30:00Z
testSent: false
header: '[DEFAULT_HEADER]'
footer: '[DEFAULT_FOOTER]'
sender:
email: newsletter@mycompany.com
name: Newsletter
id: 26
replyTo: replyto@domain.com
toField: '{FNAME} {LNAME}'
htmlContent: This is my HTML Content
shareLink: http://dhh.brevo.com/fhsgccc.html?t=9865448900
tag: Newsletter
createdAt: 2017-05-01T12:30:00Z
modifiedAt: 2017-05-01T12:30:00Z
inlineImageActivation: true
mirrorActive: true
recurring: false
recipients:
lists:
- 22
exclusionLists:
- 45
statistics:
globalStats:
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
trackableViews: 5661
trackableViewsRate: 23.45
estimatedViews: 560
unsubscriptions: 2
viewed: 8999
campaignStats:
- listId: 22
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
trackableViews: 5661
unsubscriptions: 2
viewed: 8999
deferred: 30
mirrorClick: 120
remaining: 1000
linksStats:
http://myUrl1.domain.com:
nbClick: 80
http://myUrl2.domain.com:
nbClick: 80
http://myUrl3.domain.com:
nbClick: 80
statsByDomain:
gmail:
uniqueClicks: 2300
clickers: 2665
complaints: 1
delivered: 19765
sent: 19887
softBounces: 100
hardBounces: 87
uniqueViews: 7779
unsubscriptions: 2
viewed: 8999
deferred: 30
statsByDevice:
desktop:
mac:
clickers: 1
uniqueClicks: 0
viewed: 2
uniqueViews: 1
mobile:
androidMobile:
clickers: 1
uniqueClicks: 0
viewed: 1
uniqueViews: 0
iPhone:
clickers: 1
uniqueClicks: 0
viewed: 2
uniqueViews: 0
statsByBrowser:
thunderbird:
clickers: 1
uniqueClicks: 0
viewed: 1
uniqueViews: 0
safari:
clickers: 1
uniqueClicks: 0
viewed: 1
uniqueViews: 0
internetExplorer:
clickers: 0
uniqueClicks: 0
viewed: 1
uniqueViews: 0
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: Campaign ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
put:
tags:
- Email Campaigns
summary: Update an email campaign
operationId: updateEmailCampaign
parameters:
- name: campaignId
in: path
description: Id of the campaign
required: true
schema:
type: integer
format: int64
requestBody:
description: Values to update a campaign
content:
application/json:
schema:
$ref: '#/components/schemas/updateEmailCampaign'
required: true
responses:
204:
description: Email campaign updated
content: { }
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: Campaign ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
delete:
tags:
- Email Campaigns
summary: Delete an email campaign
operationId: deleteEmailCampaign
parameters:
- name: campaignId
in: path
description: id of the campaign
required: true
schema:
type: integer
format: int64
responses:
204:
description: Email campaign has been deleted
content: { }
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: Campaign ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/emailCampaigns/{campaignId}/sendNow:
post:
tags:
- Email Campaigns
summary: Send an email campaign immediately, based on campaignId
operationId: sendEmailCampaignNow
parameters:
- name: campaignId
in: path
description: Id of the campaign
required: true
schema:
type: integer
format: int64
responses:
204:
description: Email campaign has been scheduled
content: { }
400:
description: Campaign could not be sent
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
402:
description: You don't have enough credit to send your campaign. Please update your plan
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: Campaign ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/emailCampaigns/{campaignId}/sendTest:
post:
tags:
- Email Campaigns
summary: Send an email campaign to your test list
operationId: sendTestEmail
parameters:
- name: campaignId
in: path
description: Id of the campaign
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/sendTestEmail'
required: true
responses:
204:
description: Test email has been sent successfully to all recipients
content: { }
400:
description: Test email could not be sent to the following email addresses
content:
application/json:
schema:
$ref: '#/components/schemas/postSendFailed'
404:
description: Campaign ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/postSendFailed'
/emailCampaigns/{campaignId}/status:
put:
tags:
- Email Campaigns
summary: Update an email campaign status
operationId: updateCampaignStatus
parameters:
- name: campaignId
in: path
description: Id of the campaign
required: true
schema:
type: integer
format: int64
requestBody:
description: Status of the campaign
content:
application/json:
schema:
$ref: '#/components/schemas/updateCampaignStatus'
required: true
responses:
204:
description: The campaign status has been updated successfully
content: { }
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: Campaign ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/emailCampaigns/{campaignId}/sendReport:
post:
tags:
- Email Campaigns
summary: Send the report of a campaign
description: A PDF will be sent to the specified email addresses
operationId: sendReport
parameters:
- name: campaignId
in: path
description: Id of the campaign
required: true
schema:
type: integer
format: int64
requestBody:
description: Values for send a report
content:
application/json:
schema:
$ref: '#/components/schemas/sendReport'
required: true
responses:
204:
description: Report has been successfully sent to the defined recipients
content: { }
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: Campaign ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/emailCampaigns/{campaignId}/abTestCampaignResult:
get:
tags:
- Email Campaigns
summary: Get an A/B test email campaign results
description: Obtain winning version of an A/B test email campaign
operationId: getAbTestCampaignResult
parameters:
- name: campaignId
in: path
description: Id of the A/B test campaign
required: true
schema:
type: integer
format: int64
responses:
200:
description: A/B test email campaign Result
content:
application/json:
schema:
$ref: '#/components/schemas/abTestCampaignResult'
examples:
response:
value:
winningVersion: B
winningCriteria: Click
openRate: 100%
clickRate: 50%
winningVersionRate: 0%
statistics:
openers:
Version A: 20%
Version B: 100%
clicks:
Version A: 0%
Version B: 50%
unsubscribed:
Version A: 20%
Version B: 0%
softBounces:
Version A: 0%
Version B: 0%
hardBounces:
Version A: 0%
Version B: 0%
complaints:
Version A: 0%
Version B: 0%
clickedLinks:
Version A:
- link: https://google.com
clicksCount: 0
clickRate: 0%
- link: https://youtube.com
clicksCount: 0
clickRate: 0%
Version B:
- link: http://www.github.com
clicksCount: 2
clickRate: 40%
- link: http://www.stackoverflow.com
clicksCount: 3
clickRate: 60%
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: A/B test Email Campaign not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/emailCampaigns/{campaignId}/sharedUrl:
get:
tags:
- Email Campaigns
summary: Get a shared template url
description: Get a unique URL to share & import an email template from one Brevo
account to another.
operationId: getSharedTemplateUrl
parameters:
- name: campaignId
in: path
description: Id of the campaign or template
required: true
schema:
type: integer
format: int64
responses:
200:
description: Shared template URL information
content:
application/json:
schema:
$ref: '#/components/schemas/getSharedTemplateUrl'
examples:
response:
value:
sharedUrl: https://my.brevo.com/pt2YU7R5W_guXlowgumy_VX4pFsKu._zd0Gjj96x1_GMmzc1Qps5ZIpj6nx-
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: Campaign/Template ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
405:
description: Only email campaigns or templates are allowed
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/emailCampaigns/{campaignId}/exportRecipients:
post:
tags:
- Email Campaigns
summary: Export the recipients of an email campaign
operationId: emailExportRecipients
parameters:
- name: campaignId
in: path
description: Id of the campaign
required: true
schema:
type: integer
format: int64
requestBody:
description: Values to send for a recipient export request
content:
application/json:
schema:
$ref: '#/components/schemas/emailExportRecipients'
required: false
responses:
202:
$ref: '#/components/responses/createdProcessId'
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
404:
description: Campaign ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/emailCampaigns/images:
post:
tags:
- Email Campaigns
summary: Upload an image to your account's image gallery
operationId: uploadImageToGallery
requestBody:
description: Parameters to upload an image
content:
application/json:
schema:
$ref: '#/components/schemas/uploadImageToGallery'
required: true
responses:
201:
description: Image has been successfully uploaded
content:
application/json:
schema:
$ref: '#/components/schemas/uploadImageModel'
examples:
response:
value:
url: 'https://img.mailinblue.com/100000/images/rnb/original/62casdase8wewq9df1c2f27c.jpeg'
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/smtp/email:
post:
tags:
- Transactional emails
summary: Send a transactional email
operationId: sendTransacEmail
requestBody:
description: Values to send a transactional email
content:
application/json:
schema:
$ref: '#/components/schemas/sendSmtpEmail'
required: true
responses:
201:
description: transactional email sent
content:
application/json:
schema:
$ref: '#/components/schemas/createSmtpEmail'
examples:
response:
value:
messageId: '<201798300811.5787683@relay.domain.com>'
202:
description: transactional email scheduled
content:
application/json:
schema:
$ref: '#/components/schemas/scheduleSmtpEmail'
examples:
response:
value:
messageId: '<201798300811.5787683@relay.domain.com>'
400:
description: bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorModel'
/smtp/emails:
get:
tags:
- Transactional emails
summary: Get the list of transactional emails on the basis of allowed filters
description: This endpoint will show the list of emails for past 30 days by
default. To retrieve emails before that time, please pass startDate and endDate
in query filters.
operationId: getTransacEmailsList
parameters:
- name: email
in: query
description: |
**Mandatory if templateId and messageId are not passed in query filters.** Email address to which transactional email has been sent.
schema:
type: string
- name: templateId
in: query
description: |
**Mandatory if email and messageId are not passed in query filters.** Id of the template that was used to compose transactional email.
schema:
type: integer
format: int64
- name: messageId
in: query
description: |
**Mandatory if templateId and email are not passed in query filters.** Message ID of the transactional email sent.
schema:
type: string
- name: startDate
in: query
description: |
**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the list. **Maximum time period that can be selected is one month**.
schema:
type: string
- name: endDate
in: query
description: |
**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the list. **Maximum time period that can be selected is one month.**
schema:
type: string
- name: sort
in: query
description: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
required: false
schema:
type: string
default: desc
enum:
- asc
- desc
- name: limit
in: query
description: Number of documents returned per page
schema:
maximum: 1000
minimum: 0
type: integer
format: int64
default: 500
- name: offset
in: query
description: Index of the first document in the page
schema:
type: integer
format: int64
default: 0
responses:
200:
description: List of transactional emails
content:
application/json:
schema:
$ref: '#/components/schemas/getTransacEmailsList'
examples:
response:
value:
count: 120
transactionalEmails:
- email: abc@xyz.com
subject: summer camp
templateId: 15
messageId: <201798300811.5787683@relay.domain.com>