-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
2683 lines (2680 loc) · 96.4 KB
/
openapi.yaml
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.3
info:
title: SuprSend API
description: >-
SuprSend is a central communication stack for easily creating, managing and
delivering notifications to your end users on multiple channels. Our single
notification API has all the features set, which enables you to send
notifications in a reliable and scalable manner and take care of end user
experience, thereby eliminating the need to develop any notification service
in-house for transactional/engagement notifications.
version: 1.2.1
x-konfig-ignore:
object-with-no-properties: true
potential-incorrect-type: true
servers:
- url: https://hub.suprsend.com
tags:
- name: Subscriber
- name: Brand
- name: SubscriberList
- name: Template
- name: Preference
- name: Event
- name: Workflow
- name: PrefCategory
- name: Sync
- name: Broadcast
paths:
/v1/template:
get:
tags:
- Template
summary: Fetch Template List
operationId: Template_getList
description: APIs to fetch the list of all templates in a workspace
parameters:
- description: comma separated string of tag ids attached to the template
name: has_tag_ids_any
in: query
schema:
type: string
- description: >-
comma separated string of channels. Returns templates which has any
of the channels present from the channel string. Use these keys for
channels - `email`, `sms`, `whatsapp`, `inbox`, `slack`,
`androidpush`, `iospush`, `webpush`
name: has_channels_any
in: query
schema:
type: string
- description: >-
Set `true` for published templates, `false` for templates which are
in draft. Do not pass this key to return all templates.
name: is_active
in: query
schema:
type: boolean
- description: Set `true` to get archived templates, default = `false`
name: is_archived
in: query
schema:
type: boolean
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: |-
{
"meta": {
"count": 1,
"limit": 10,
"offset": 0
},
"results": [
{
"id": 2445,
"name": "Grocery Purchased",
"slug": "grocery-purchased",
"description": null,
"is_active": true,
"default_language": {
"name": "English",
"slug": "en"
},
"created_at": "2023-01-25T04:53:39.237291Z",
"updated_at": "2023-08-28T05:06:22.461443Z",
"updated_by": {
"name": "Joe",
"email": "joe@example.com"
},
"last_triggered_at": "2023-08-10T12:44:03.361158Z",
"is_auto_translate_enabled": false,
"enabled_languages": [
"en",
"hi",
"kn"
],
"channels": [
{
"id": 3944,
"channel": {
"name": "Email",
"slug": "email",
"is_template_approval_needed": true
},
"is_active": true,
"is_enabled": true,
"created_at": "2023-01-25T04:53:39.268299Z",
"updated_at": "2023-01-25T04:53:39.404273Z",
"disabled_languages": [],
"versions": []
}],
"tags": []
}
]
}
schema:
$ref: '#/components/schemas/TemplateGetListResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/TemplateGetList400Response'
deprecated: false
/v1/template/{template_slug}:
get:
tags:
- Template
summary: Fetch Template details
operationId: Template_getDetails
description: >-
APIs to fetch the content of a template group. It will return data for
live and draft version of a template.
parameters:
- description: >-
Template group slug you want to fetch content details. You'll get
the template slug by clicking on copy button next to template group
name on SuprSend dashboard -> template details page.
name: template_slug
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: |-
{
"id": 2445,
"name": "Grocery Purchased",
"slug": "grocery-purchased",
"description": null,
"is_active": true,
"default_language": {
"name": "English",
"slug": "en"
},
"created_at": "2023-01-25T04:53:39.237291Z",
"updated_at": "2023-08-28T05:06:22.461443Z",
"updated_by": {
"name": "Joe",
"email": "joe@example.com"
},
"last_triggered_at": "2023-08-10T12:44:03.361158Z",
"is_auto_translate_enabled": false,
"enabled_languages": [
"en",
"hi",
"kn"
],
"channels": [
{
"id": 3944,
"channel": {
"name": "SMS",
"slug": "sms",
"is_template_approval_needed": true
},
"is_active": true,
"is_enabled": true,
"created_at": "2023-01-25T04:53:39.268299Z",
"updated_at": "2023-01-25T04:53:39.404273Z",
"disabled_languages": [],
"versions": [
{
"id": 10820,
"templates": [
{
"id": 11866,
"language": {
"name": "English",
"slug": "en"
},
"is_enabled": true,
"approval_status": "approved",
"content": {
"text": "You purchased product {#var#} worth Rs. {#var#} will reach to you {#var#}. You can track your order here: {#var#}\n- SuprSend",
"header": "SPRSND",
"example": [
"Winter Raincoat",
"INR 5",
"999",
"Bengaluru",
"https://www.google.com"
],
"vendor_slug": "acl-sms",
"content_type": "1",
"message_type": "SERVICE_IMPLICIT",
"template_name": "purchase_made_en_v2",
"enterprise_name": "SPRSND",
"handlebars_text": "You purchased product {{event.product_name}} worth Rs. {{event.amount}} will reach to you {{event.location.city}}. You can track your order here: {{event.link}}\n- SuprSend",
"vendor_template_id": "1007xxxxxxxxxx"
},
"created_at": "2023-01-25T04:53:39.295289Z",
"updated_at": "2023-01-25T04:53:39.328651Z",
"updated_by": {
"name": "Steve",
"email": "steve@example.com"
},
"approval_cycle": {
"status": "approved",
"comment": null,
"request_received_at": "2022-03-31T10:35:51+0000",
"sent_for_approval_at": null,
"approval_status_received_at": "2022-03-31T10:43:44+0000"
},
"is_approval_needed": true,
"is_cloned_from_last_version": false
}
],
"status": "active",
"version_tag": "1",
"created_at": "2023-01-25T04:53:39.276782Z",
"updated_at": "2023-01-25T04:53:39.342850Z",
"updated_by": {
"name": "Joe",
"email": "joe@example.com"
},
"version_tag_user": "v1",
"published_languages": [
"en"
],
"apparent_published_languages": [
"en"
]
},
{
"id": 10821,
"templates": [
{
"id": 11867,
"language": {
"name": "English",
"slug": "en"
},
"is_enabled": true,
"approval_status": "pending",
"content": {
"text": "You purchased product {#var#} worth Rs. {#var#} will reach to you {#var#}. You can track your order here: {#var#}\n- SuprSend",
"header": "SPRSND",
"example": [
"Winter Raincoat",
"INR 5",
"999",
"Bengaluru",
"https://www.google.com"
],
"vendor_slug": "acl-sms",
"content_type": "1",
"message_type": "SERVICE_IMPLICIT",
"template_name": "purchase_made_en_v2",
"enterprise_name": "SPRSND",
"handlebars_text": "You purchased product {{event.product_name}} worth Rs. {{event.amount}} will reach to you {{event.location.city}}. You can track your order here: {{event.link}}\n- SuprSend",
"vendor_template_id": "1007017737717135821"
},
"created_at": "2023-01-25T04:53:39.367525Z",
"updated_at": "2023-01-25T04:53:39.367556Z",
"updated_by": {
"name": "Joe",
"email": "joe@example.com"
},
"approval_cycle": null,
"is_approval_needed": true,
"is_cloned_from_last_version": false
},
{
"id": 11891,
"language": {
"name": "French",
"slug": "fr"
},
"is_enabled": true,
"approval_status": "pending",
"content": {
"template_name": "grocery_purchased_hi"
},
"created_at": "2023-01-25T05:46:26.753095Z",
"updated_at": "2023-01-25T05:46:26.753121Z",
"updated_by": {
"name": "Joe",
"email": "joe@example.com"
},
"approval_cycle": null,
"is_approval_needed": true,
"is_cloned_from_last_version": false
}]
}
],
"tags": []
}
]
}
schema:
$ref: '#/components/schemas/TemplateGetDetailsResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/TemplateGetDetails400Response'
deprecated: false
/v1/template/{template_slug}/channel/{channel_slug}:
get:
tags:
- Template
summary: Fetch Template content for a channel
operationId: Template_getContentChannel
description: >-
APIs to fetch the content of a particular channel in a template group.
It will return data for live and draft version of a template.
parameters:
- description: >-
Template group slug you want to fetch content details. You'll get
the template slug by clicking on copy button next to template group
name on SuprSend dashboard -> template details page.
name: template_slug
in: path
schema:
type: string
required: true
- description: >-
add one of the template channels - `email`, `sms`, `whatsapp`,
`inbox`, `slack`, `androidpush`, `iospush`, `webpush`
name: channel_slug
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: |-
{
"id": 3949,
"channel": {
"name": "In-App Inbox",
"slug": "inbox",
"is_template_approval_needed": false
},
"is_active": true,
"is_enabled": true,
"created_at": "2023-01-25T04:53:40.011112Z",
"updated_at": "2023-07-27T14:55:23.939438Z",
"disabled_languages": [],
"versions": [
{
"id": 10830,
"templates": [
{
"id": 11876,
"language": {
"name": "English",
"slug": "en"
},
"is_enabled": true,
"approval_status": "auto_approved",
"content": {
"url": "",
"text": "We will soon deliver {{event.product_name}} to {{event.location.city}} 😀",
"image": "",
"header": "Order Confirmed {{event.date}}",
"schema": "1.0",
"extra_data": "{\n\"city\": \"{{event.amount}}\"\n}"
},
"created_at": "2023-01-25T04:53:40.035836Z",
"updated_at": "2023-01-25T04:53:40.069659Z",
"updated_by": {
"name": "Joe",
"email": "joe@example.com"
},
"approval_cycle": null,
"is_approval_needed": false,
"is_cloned_from_last_version": false
}
],
"status": "active",
"version_tag": "1",
"created_at": "2023-01-25T04:53:40.016463Z",
"updated_at": "2023-01-25T04:53:40.083969Z",
"updated_by": {
"name": "Steve",
"email": "steve@example.com"
},
"version_tag_user": "v1",
"published_languages": [
"en"
],
"apparent_published_languages": [
"en"
]
},
{
"id": 10831,
"templates": [
{
"id": 11877,
"language": {
"name": "English",
"slug": "en"
},
"is_enabled": true,
"approval_status": "auto_approved",
"content": {
"url": "",
"text": "We will soon deliver {{event.product_name}} to {{event.location.city}} 😀 {{$embedded_preference_url}}",
"image": "",
"header": "Order Confirmed {{event.date}}",
"schema": "1.0",
"extra_data": "{\n\"city\": \"{{event.amount}}\"\n}"
},
"created_at": "2023-01-25T04:53:40.112492Z",
"updated_at": "2023-07-27T14:55:23.933072Z",
"updated_by": {
"name": "Joe",
"email": "joe@example.com"
},
"approval_cycle": null,
"is_approval_needed": false,
"is_cloned_from_last_version": false
}
],
"status": "draft",
"version_tag": "_",
"created_at": "2023-01-25T04:53:40.098853Z",
"updated_at": "2023-07-27T14:55:23.937661Z",
"updated_by": {
"name": "Steve",
"email": "steve@example.com"
},
"version_tag_user": null,
"published_languages": [],
"apparent_published_languages": []
}
]
}
schema:
$ref: '#/components/schemas/TemplateGetContentChannelResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/TemplateGetContentChannel400Response'
deprecated: false
/v1/brand/{brand_id}:
post:
tags:
- Brand
summary: Create / Update Brands
operationId: Brand_createOrUpdate
description: API to create a new Brand OR update an existing Brand
parameters:
- description: unique identifier of the brand that you want to create / update
name: brand_id
in: path
schema:
type: string
required: true
- name: Content - Type
in: header
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BrandCreateOrUpdateRequest'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/BrandCreateOrUpdateResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/BrandCreateOrUpdate400Response'
deprecated: false
get:
tags:
- Brand
summary: Get Brand data
operationId: Brand_brandDataGet
description: API to get brand settings corresponding to a brand id
parameters:
- description: unique identifier of the brand you want to get the details for
name: brand_id
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/BrandBrandDataGetResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/BrandBrandDataGet400Response'
deprecated: false
/v1/subscriber/{distinct_id}/category/{category_slug}:
post:
tags:
- Subscriber
summary: Update User Preferences (Category level)
operationId: Subscriber_updateUserPreferencesCategory
description: API to update user category preferences
parameters:
- description: distinct_id of the user whose preferences should be fetched
name: distinct_id
in: path
schema:
type: string
required: true
- description: to fetch user preferences for a particular brand
name: tenant_id
in: query
schema:
type: string
- description: >-
notification category slug. You can get this from Notification
Categories page on SuprSend dashboard -> Settings page
name: category_slug
in: path
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/SubscriberUpdateUserPreferencesCategoryRequest
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: >-
#/components/schemas/SubscriberUpdateUserPreferencesCategoryResponse
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: >-
#/components/schemas/SubscriberUpdateUserPreferencesCategory400Response
deprecated: false
/v1/subscriber_list/{list_id}/subscriber/add:
post:
tags:
- Subscriber
summary: Add Subscribers to List
operationId: Subscriber_addToList
description: API to add users / subscribers to the list
parameters:
- description: >-
Unique string idenitifier of the list to which user needs to be
updated
name: list_id
in: path
required: true
schema:
type: string
default: _list_id_
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriberAddToListRequest'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberAddToListResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberAddToList400Response'
deprecated: false
/v1/subscriber_list/{list_id}/subscriber/remove:
post:
tags:
- SubscriberList
summary: Remove Subscribers from List
operationId: SubscriberList_removeSubscribersFromList
description: API to remove users / subscribers from the list
parameters:
- description: >-
Unique string idenitifier of the list to which user needs to be
updated
name: list_id
in: path
required: true
schema:
type: string
default: _list_id_
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/SubscriberListRemoveSubscribersFromListRequest
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: >-
#/components/schemas/SubscriberListRemoveSubscribersFromListResponse
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: >-
#/components/schemas/SubscriberListRemoveSubscribersFromList400Response
deprecated: false
/v1/subscriber_list/{list_id}/delete:
patch:
tags:
- SubscriberList
summary: Delete List
operationId: SubscriberList_deleteList
description: API to delete a list created in your workspace
parameters:
- description: Unique string idenitifier of the list which you want to delete
name: list_id
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberListDeleteListResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberListDeleteList400Response'
deprecated: false
/v1/subscriber_list/{list_id}/version/{version_id}/delete:
patch:
tags:
- Subscriber
summary: Delete Draft List
operationId: Subscriber_deleteDraftList
description: API to delete a list created in your workspace
parameters:
- description: Unique string idenitifier of the list which you want to delete
name: list_id
in: path
schema:
type: string
required: true
- description: >-
Unique identifier of the draft version of the list which needs to be
deleted
name: version_id
in: path
schema:
type: string
default: __version_id__
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberDeleteDraftListResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberDeleteDraftList400Response'
deprecated: false
/v1/subscriber_list/{list_id}/start_sync:
post:
tags:
- Sync
summary: Start Sync
operationId: Sync_listStartSync
description: >-
Starts sync on the active(live) version of the list, identified by
list_id, and creates an empty draft version.
parameters:
- description: >-
Unique identifier of the list on which the sync needs to start to
create a draft version
name: list_id
in: path
schema:
type: string
default: _list_id_
required: true
responses:
'201':
description: '201'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SyncListStartSyncResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SyncListStartSync400Response'
deprecated: false
/v1/subscriber_list/{list_id}/version/{version_id}/subscriber/add:
post:
tags:
- Subscriber
summary: Add Subscribers to Draft List
operationId: Subscriber_addToDraftList
description: >-
Add subscribers to a draft list with a version_id that uniquely
identifies the draft list
parameters:
- description: >-
Unique string idenitifier of the list to which user needs to be
updated
name: list_id
in: path
schema:
type: string
default: _list_id_
required: true
- description: >-
Unique string idenitifier of the draft version of the list to which
user needs to be updated
name: version_id
in: path
schema:
type: string
default: __version_id__
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriberAddToDraftListRequest'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberAddToDraftListResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberAddToDraftList400Response'
deprecated: false
/v1/subscriber_list/{list_id}/version/{version_id}/subscriber/remove:
post:
tags:
- Subscriber
summary: Remove Subscribers from Draft List
operationId: Subscriber_removeFromDraftList
description: >-
Remove subscribers from a draft list with a version_id that uniquely
identifies the draft list
parameters:
- description: >-
Unique string idenitifier of the list to which user needs to be
updated
name: list_id
in: path
schema:
type: string
default: _list_id_
required: true
- description: >-
Unique string idenitifier of the draft version of the list to which
user needs to be updated
name: version_id
in: path
schema:
type: string
default: __version_id__
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriberRemoveFromDraftListRequest'
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberRemoveFromDraftListResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberRemoveFromDraftList400Response'
deprecated: false
/v1/subscriber_list/{list_id}/version/{version_id}/finish_sync:
patch:
tags:
- Subscriber
summary: Finish Sync
operationId: Subscriber_finishSyncDraftVersion
description: >-
Finishes the sync for a draft version and makes that particular version
live for the given list_id
parameters:
- description: Unique string idenitifier of the list
name: list_id
in: path
schema:
type: string
default: _list_id_
required: true
- description: >-
Unique string idenitifier of the draft version of the list which
needs to be made active(live)
name: version_id
in: path
schema:
type: string
default: __version_id__
required: true
responses:
'201':
description: '201'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: '#/components/schemas/SubscriberFinishSyncDraftVersionResponse'
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
$ref: >-
#/components/schemas/SubscriberFinishSyncDraftVersion400Response
deprecated: false
/{workspace_key}/broadcast:
post:
tags:
- Broadcast
summary: Trigger Broadcast
operationId: Broadcast_triggerMessageList
description: API to trigger broadcast messages on a list of users
parameters:
- name: workspace_key
in: path
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BroadcastTriggerMessageListRequest'
responses:
'202':
description: '202'
content:
application/json:
examples:
Result:
value: '{}'
schema: