-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
9716 lines (9715 loc) · 314 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: Dixa API
description: >-
Dixa enables companies to deliver customer service as it is meant to be. We
help customer service leaders to create effortless experiences for customers
and teams that unlock loyalty.
Dixa's Conversational Customer Service Platform combines powerful AI with a
human touch to deliver a highly-personalized service experience that scales.
Our dedicated customer success team ensures you are up and running quickly.
Dixa powers more than 30 million conversations a year and is trusted by
leading brands such as Interflora, On, Wise, Deezer, Rapha, Too Good to Go,
Hello Print, and Wistia. Learn more by visiting dixa.com.
version: v1
servers:
- url: https://dev.dixa.io
tags:
- name: Conversations
- name: Agents
- name: End Users
- name: Teams
- name: Tags
- name: Analytics
- name: Webhooks
- name: Queues
- name: Anonymization
- name: Custom Attributes
- name: Internal Notes
- name: Contact Endpoints
- name: Ratings
- name: Messages
- name: Search
paths:
/v1/analytics/metrics:
get:
tags:
- Analytics
summary: Metrics Catalogue
operationId: Analytics_listMetrics
description: >-
This endpoint lists all available metric IDs that can be used to fetch
data in Get Metric Data
parameters:
- description: >-
Maximum number of results per page. May be used in combination with
pageKey to change the number of results in between page requests.
name: pageLimit
in: query
required: false
schema:
type: integer
format: int32
- description: >-
Base64 encoded form of pagination query parameters. Do not try to
construct or change programmatically as the internal structure may
change without notice.
name: pageKey
in: query
required: false
schema:
type: string
responses:
'200':
description: The catalogue of metrics
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricsOutput'
example:
data:
- description: >-
(Number of satisfied customers (4 and 5)/ Number of survey
responses) x 100 = % of satisfied customers
id: csat
filters:
- description: Used to filter by the agent_id
filterAttribute: agent_id
- description: Used to filter by the queue_id
filterAttribute: queue_id
- description: Used to filter by the channel
filterAttribute: channel
- description: Used to filter by the initial_direction
filterAttribute: initial_direction
- description: Used to filter by the tag_id
filterAttribute: tag_id
- description: Used to filter by the contact_point
filterAttribute: contact_point
aggregations:
- description: Calculated Percentage
measure: Percentage
relatedRecordIds:
- ratings
- description: Closed conversation data
id: closed_conversations
filters:
- description: Used to filter by the queue_id
filterAttribute: queue_id
- description: Used to filter by the channel
filterAttribute: channel
- description: Used to filter by the initial_direction
filterAttribute: initial_direction
- description: Used to filter by the tag_id
filterAttribute: tag_id
- description: Used to filter by the contact_point
filterAttribute: contact_point
aggregations:
- description: Conversation closed count
measure: Count
relatedRecordIds:
- closed_conversations
'400':
description: >-
Invalid value extracted from request context, Invalid value for:
query parameter pageLimit, Invalid value for: query parameter
pageKey
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
post:
tags:
- Analytics
summary: Get Metric Data
operationId: Analytics_getMetricData
description: Get data of a specific metric (aggregated)
requestBody:
description: >-
The available request filters and aggregations for fetching the metric
data
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricDataInput'
example:
id: closed_conversationsX
periodFilter:
value:
_type: PreviousWeek
_type: Preset
filters:
- attribute: channel
values:
- email
aggregations:
- Count
timezone: Europe/Copenhagen
required: true
responses:
'200':
description: The metric data
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricDataOutput'
example:
data:
id: closed_conversationsX
aggregates:
- value: 42
measure: Count
_type: LongAggregateValue
'400':
description: >-
Invalid value extracted from request context, Invalid value for:
body
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
/v1/analytics/metrics/{metricId}:
get:
tags:
- Analytics
summary: Metric Description
operationId: Analytics_getMetricDescription
description: >-
This endpoint lists all available properties of a metric to use for
querying its data
parameters:
- name: metricId
in: path
required: true
schema:
type: string
responses:
'200':
description: The metric properties
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricOutput'
example:
data:
description: >-
(Number of satisfied customers (4 and 5)/ Number of survey
responses) x 100 = % of satisfied customers
id: csatX
filters:
- description: Used to filter by the agent_id
filterAttribute: agent_id
- description: Used to filter by the queue_id
filterAttribute: queue_id
- description: Used to filter by the channel
filterAttribute: channel
- description: Used to filter by the initial_direction
filterAttribute: initial_direction
- description: Used to filter by the tag_id
filterAttribute: tag_id
- description: Used to filter by the contact_point
filterAttribute: contact_point
aggregations:
- description: Calculated Percentage
measure: Percentage
relatedRecordIds:
- ratings
'400':
description: Invalid value extracted from request context
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
/v1/analytics/filter/{filterAttribute}:
get:
tags:
- Analytics
summary: Filter values
operationId: Analytics_filterValues
description: >-
Get possible values to be used with a given filter attribute. Filter
attributes are not metric or record specific, so one filter attribute
can be used with multiple metrics/records. When a filter value is not
relevant for a specific metric/record, it is simply ignored.
parameters:
- name: filterAttribute
in: path
required: true
schema:
type: string
- description: >-
Maximum number of results per page. May be used in combination with
pageKey to change the number of results in between page requests.
name: pageLimit
in: query
required: false
schema:
type: integer
format: int32
- description: >-
Base64 encoded form of pagination query parameters. Do not try to
construct or change programmatically as the internal structure may
change without notice.
name: pageKey
in: query
required: false
schema:
type: string
responses:
'200':
description: >-
The possible filter values to be used when fetching metrics or
records
content:
application/json:
schema:
$ref: '#/components/schemas/GetFilterValuesOutput'
example:
data:
- value: CALLBACK
label: Callback
- value: CONTACT_FORM
label: Contact Form
'400':
description: >-
Invalid value extracted from request context, Invalid value for:
query parameter pageLimit, Invalid value for: query parameter
pageKey
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
/v1/analytics/records:
get:
tags:
- Analytics
summary: Metric Records Catalogue
operationId: Analytics_listRecords
description: >-
This endpoint lists all available record IDs that can be used to fetch
data in Get Metric Records Data
parameters:
- description: >-
Maximum number of results per page. May be used in combination with
pageKey to change the number of results in between page requests.
name: pageLimit
in: query
required: false
schema:
type: integer
format: int32
- description: >-
Base64 encoded form of pagination query parameters. Do not try to
construct or change programmatically as the internal structure may
change without notice.
name: pageKey
in: query
required: false
schema:
type: string
responses:
'200':
description: The catalogue of metric records
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricRecordsOutput'
example:
data:
- description: Conversation Ratings
id: ratings
filters:
- description: Used to filter by the agent_id
filterAttribute: agent_id
- description: Used to filter by the queue_id
filterAttribute: queue_id
- description: Used to filter by the channel
filterAttribute: channel
- description: Used to filter by the initial_direction
filterAttribute: initial_direction
- description: Used to filter by the tag_id
filterAttribute: tag_id
- description: Used to filter by the contact_point
filterAttribute: contact_point
relatedMetricIds:
- csat
fieldsMetadata:
- description: Conversation ID
field: conversation_id
nullable: false
- description: The agent assigned to the conversation
field: agent_id
nullable: true
- description: >-
The queue which the conversation was part of when the
conversation was offered
field: queue_id
nullable: true
- description: Closed conversation data
id: closed_conversationsX
filters:
- description: Used to filter by the queue_id
filterAttribute: queue_id
- description: Used to filter by the channel
filterAttribute: channel
- description: Used to filter by the initial_direction
filterAttribute: initial_direction
- description: Used to filter by the tag_id
filterAttribute: tag_id
- description: Used to filter by the contact_point
filterAttribute: contact_point
relatedMetricIds:
- closed_conversations
fieldsMetadata:
- description: Timestamp of when the conversation was closed
field: closed_at
nullable: false
- description: Conversation ID
field: conversation_id
nullable: false
- description: The agent closing the conversation
field: agent_id
nullable: true
- description: >-
The queue which the conversation was part of when the
conversation was closed
field: queue_id
nullable: true
- description: >-
User closing the conversation (Agent, Enduser or
Unknown)
field: closed_by
nullable: false
'400':
description: >-
Invalid value extracted from request context, Invalid value for:
query parameter pageLimit, Invalid value for: query parameter
pageKey
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
post:
tags:
- Analytics
summary: Get Metric Records Data
operationId: Analytics_getMetricRecordsData
description: Get data of specific metric records (unaggregated)
parameters:
- description: >-
Maximum number of results per page. May be used in combination with
pageKey to change the number of results in between page requests.
name: pageLimit
in: query
required: false
schema:
type: integer
format: int32
- description: >-
Base64 encoded form of pagination query parameters. Do not try to
construct or change programmatically as the internal structure may
change without notice.
name: pageKey
in: query
required: false
schema:
type: string
requestBody:
description: The available request filters for fetching the metric records data
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricRecordsDataInput'
example:
id: closed_conversationsX
periodFilter:
value:
_type: PreviousWeek
_type: Preset
filters:
- attribute: initial_direction
values:
- INBOUND
timezone: Europe/Copenhagen
required: true
responses:
'200':
description: The metric records data
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricRecordsDataOutput'
examples:
No Value Metric Records Data Example:
value:
data:
- primaryTimestampField:
name: created_at
timestamp: '2023-04-21T10:23:14.293Z'
fields:
- name: csid
field:
value: 184472
_type: LongField
- name: initial_direction
field:
value: INBOUND
label: Inbound
_type: StringField
- name: initial_channel
field:
value: PSTN_PHONE
label: Phone
_type: StringField
- name: contact_point
field:
value: '+4511223344'
label: '+4511223344'
_type: StringField
- primaryTimestampField:
name: created_at
timestamp: '2023-04-21T10:24:04.259Z'
fields:
- name: csid
field:
value: 184473
_type: LongField
- name: initial_direction
field:
value: INBOUND
label: Inbound
_type: StringField
- name: initial_channel
field:
value: EMAIL
label: Email
_type: StringField
- name: contact_point
field:
value: dixa@email.com
label: dixa@email.com
_type: StringField
Metric Records Data Example:
value:
data:
- primaryTimestampField:
name: created_at
timestamp: '2023-04-21T10:23:01.293Z'
value:
value: 4
_type: LongField
fields:
- name: csid
field:
value: 184474
_type: LongField
- name: current_channel
field:
value: EMAIL
label: Email
_type: StringField
- name: queue
field:
value: 220ffe6a-3040-4ece-ae3a-c4c6d63ff3cc
label: Example queue
_type: UUIDField
- primaryTimestampField:
name: created_at
timestamp: '2023-04-21T10:23:04.930Z'
value:
value: 5
_type: LongField
fields:
- name: csid
field:
value: 184475
_type: LongField
- name: current_channel
field:
value: CONTACT_FORM
label: Contact form
_type: StringField
- name: queue
field:
value: 57582f31-4fce-4435-b489-e1c7f190a92f
label: Example queue 2
_type: UUIDField
'400':
description: >-
Invalid value extracted from request context, Invalid value for:
query parameter pageLimit, Invalid value for: query parameter
pageKey, Invalid value for: body
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
/v1/analytics/records/{recordId}:
get:
tags:
- Analytics
summary: Metric Record Description
operationId: Analytics_getRecordProperties
description: >-
This endpoint lists all available properties of a record to use for
querying its data
parameters:
- name: recordId
in: path
required: true
schema:
type: string
responses:
'200':
description: The metric record properties
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricRecordOutput'
example:
data:
description: Conversation Ratings
id: ratingsX
filters:
- description: Used to filter by the agent_id
filterAttribute: agent_id
- description: Used to filter by the queue_id
filterAttribute: queue_id
- description: Used to filter by the channel
filterAttribute: channel
- description: Used to filter by the initial_direction
filterAttribute: initial_direction
- description: Used to filter by the tag_id
filterAttribute: tag_id
- description: Used to filter by the contact_point
filterAttribute: contact_point
relatedMetricIds:
- csat
fieldsMetadata:
- description: Conversation ID
field: conversation_id
nullable: false
- description: The agent assigned to the conversation
field: agent_id
nullable: true
- description: >-
The queue which the conversation was part of when the
conversation was offered
field: queue_id
nullable: true
'400':
description: Invalid value extracted from request context
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
/v1/agents/presence:
get:
tags:
- Agents
summary: List presence
operationId: Agents_listPresence
description: List the presence status for all agents/admins in an organization.
responses:
'200':
description: The list of presence status for all agents/admins
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsListPresenceResponse'
example:
- userId: d31a73fc-d67b-49ec-9534-1f36a0c4c906
requestTime: '2021-12-01T12:46:35.935'
lastSeen: '2021-12-01T12:46:35.935'
presenceStatus: Working
connectionStatus: Online
activeChannels:
- Email
- FacebookMessenger
- userId: 8026cb51-184b-424f-8686-c6bc7bcf88eb
requestTime: '2021-12-01T12:46:35.935'
lastSeen: '2021-12-01T12:46:35.935'
presenceStatus: Working
connectionStatus: Online
activeChannels:
- Email
- FacebookMessenger
- PstnPhone
'400':
description: Invalid value extracted from request context
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal failure during request processing
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
/v1/agents:
get:
tags:
- Agents
summary: List agents
operationId: Agents_list
description: >-
Lists all agents/admins in an organization. It is possible to filter by
one of the mutually exclusive parameters: email or phone number. In case
both are provided, an error is returned.
parameters:
- description: >-
Maximum number of results per page. May be used in combination with
pageKey to change the number of results in between page requests.
name: pageLimit
in: query
required: false
schema:
type: integer
format: int32
- description: >-
Base64 encoded form of pagination query parameters. Do not try to
construct or change programmatically as the internal structure may
change without notice.
name: pageKey
in: query
required: false
schema:
type: string
- description: The agent/admin email filter
name: email
in: query
required: false
schema:
type: string
- description: The agent/admin phone number filter
name: phone
in: query
required: false
schema:
type: string
responses:
'200':
description: The list of agents/admins
content:
application/json:
schema:
$ref: '#/components/schemas/ListAgentsOutput'
example:
data:
- id: 93b885ad-fe0d-3089-8df6-34904fd59f71
createdAt: '2020-12-16T09:41:43Z'
displayName: Agent 0
email: agent.0@example.org
avatarUrl: https://files.dixa.io/public/image_0_id
additionalEmails: []
additionalPhoneNumbers: []
middleNames: []
roles:
- Agent
- id: 55a54008-ad1b-3589-aa21-0d2629c1df41
createdAt: '2020-12-16T09:41:43Z'
displayName: Agent 1
email: agent.1@example.org
avatarUrl: https://files.dixa.io/public/image_1_id
additionalEmails: []
additionalPhoneNumbers: []
middleNames: []
roles:
- Agent
- id: 9e688c58-a548-3b8e-af69-c9e1005ad0bf
createdAt: '2020-12-16T09:41:43Z'
displayName: Agent 2
email: agent.2@example.org
avatarUrl: https://files.dixa.io/public/image_2_id
additionalEmails: []
additionalPhoneNumbers: []
middleNames: []
roles:
- Agent
- id: 86666835-06aa-3d90-8bbd-5a74ac4edf68
createdAt: '2020-12-16T09:41:43Z'
displayName: Agent 3
email: agent.3@example.org
avatarUrl: https://files.dixa.io/public/image_3_id
additionalEmails: []
additionalPhoneNumbers: []
middleNames: []
roles:
- Agent
'400':
description: >-
Invalid value extracted from request context, Invalid value for:
query parameter pageLimit, Invalid value for: query parameter
pageKey, Invalid value for: query parameter email, Invalid value
for: query parameter phone, Duplicate phone number, Duplicate email
address, Invalid filters: Cannot provide both phone number and email
address
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Decoding failure in request
'404':
description: An entity in this request could not be found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
example:
message: The requested resource could not be found
'500':
description: Internal failure during request processing
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
put:
tags:
- Agents
summary: Update agents
operationId: Agents_updateBulk
description: Bulk update agents/admins.
requestBody:
description: The list of agent/admin update actions
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsUpdateBulkRequest'
example:
- id: 434ce9f5-14c8-4be1-a0a8-f755010deb9b
displayName: Alice Brown
phoneNumber: '+551155256325'
additionalEmails: []
additionalPhoneNumbers: []
firstName: Alice
lastName: Brown
middleNames: []
avatarUrl: http://avatar.url
required: false
responses:
'200':
description: The list of update action outcomes
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdateAgentOutput'
example:
data:
- data:
id: 4d2ab456-8510-4a35-b266-e502160d5177
createdAt: '2020-12-16T09:41:43Z'
displayName: Alice Brown
email: alice@brown.com
avatarUrl: https://files.dixa.io/public/image_id
phoneNumber: '+551155256325'
additionalEmails:
- alice@secondary.email
additionalPhoneNumbers:
- '+5566778899'
firstName: Alice
lastName: Brown
middleNames: []
roles:
- Agent
_type: BulkActionSuccess
'400':
description: >-
Invalid value extracted from request context, Invalid value for:
body
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Invalid value in request
'500':
description: Internal failure during request processing
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
post:
tags:
- Agents
summary: Create agent
operationId: Agents_createAgent
description: Create an agent.
requestBody:
description: The agent's details
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAgentInput'
example:
displayName: Alice Brown
email: alice@brown.com
phoneNumber: '+551155256325'
additionalEmails:
- alice@secondary.email
additionalPhoneNumbers:
- '+5566778899'
firstName: Alice
lastName: Brown
middleNames: []
avatarUrl: http://avatar.url
required: true
responses:
'201':
description: The created agent
content:
application/json:
schema:
$ref: '#/components/schemas/AgentOutput'
example:
data:
id: 4d2ab456-8510-4a35-b266-e502160d5177X
createdAt: '2020-12-16T09:41:43Z'
displayName: Alice Brown
email: alice@brown.com
avatarUrl: https://files.dixa.io/public/image_id
phoneNumber: '+551155256325'
additionalEmails:
- alice@secondary.email
additionalPhoneNumbers:
- '+5566778899'
firstName: Alice
lastName: Brown
middleNames: []
roles:
- Agent
'400':
description: >-
Invalid value extracted from request context, Invalid value for:
body, Validation failure during agent creation
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
example:
message: Decoding failure in request
'500':
description: Internal failure during request processing
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
example:
message: >-
There was an internal server error while processing the
request
patch:
tags: