-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
9834 lines (9751 loc) · 307 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.0
info:
title: Core API
description: >-
Front is a customer operations platform that enables support, sales, and
account management teams to deliver exceptional service at scale. Front
streamlines customer communication by combining the efficiency of a help
desk and the familiarity of email, with automated workflows and real-time
collaboration behind the scenes.
With Front, teams can centralize messages across channels, route them to the
right person, and unlock visibility and insights across all of their
customer operations. More than 8000 businesses use Front to drive
operational efficiency that prevents churn, improves retention, and propels
customer growth.
version: 1.0.0
contact:
name: Front Platform
url: https://community.front.com
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://api2.frontapp.com
tags:
- name: Knowledge Bases
- name: Conversations
- name: Tags
- name: Teammate groups
- name: Contacts
- name: Message Template Folders
- name: Message Templates
- name: Contact Groups
- name: Inboxes
- name: Shifts
- name: Accounts
- name: Custom Fields
- name: Channels
- name: Messages
- name: Signatures
- name: Drafts
- name: Rules
- name: Links
- name: Teammates
- name: Analytics
- name: Comments
- name: Teams
- name: Contact Handles
- name: Contact Notes
- name: Events
- name: Attachments
- name: Token Identity
paths:
/accounts:
get:
tags:
- Accounts
summary: List Accounts
operationId: Accounts_listCompanyAccounts
description: List the accounts of the company.
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/sortByAccounts'
- $ref: '#/components/parameters/sortOrder'
responses:
'200':
$ref: '#/components/responses/listOfAccounts'
post:
tags:
- Accounts
summary: Create account
operationId: Accounts_createNewAccount
description: Create a new account.
requestBody:
content:
application/json:
schema:
required:
- name
$ref: '#/components/schemas/Account'
responses:
'201':
$ref: '#/components/responses/account'
/accounts/custom_fields:
get:
tags:
- Custom Fields
summary: List Account's custom fields
operationId: CustomFields_listAccountCustomFields
description: Lists the custom fields that can be attached to an Account.
responses:
'200':
$ref: '#/components/responses/listOfCustomFields'
/accounts/{account_id}:
get:
tags:
- Accounts
summary: Fetch an account
operationId: Accounts_getAccount
description: Fetches an account
parameters:
- description: >-
The Account ID. Alternatively, you can supply the account domain or
external ID as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: account_id
required: true
schema:
type: string
default: acc_123
responses:
'200':
$ref: '#/components/responses/account'
patch:
tags:
- Accounts
summary: Update account
operationId: Accounts_updateAccount
description: Updates an account.
parameters:
- description: >-
The Account ID. Alternatively, you can supply the account domain or
external ID as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: account_id
required: true
schema:
type: string
default: acc_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountPatch'
responses:
'200':
$ref: '#/components/responses/account'
delete:
tags:
- Accounts
summary: Delete an account
operationId: Accounts_deleteAccount
description: Deletes an account
parameters:
- description: >-
The Account ID. Alternatively, you can supply the account domain or
external ID as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: account_id
required: true
schema:
type: string
default: acc_123
responses:
'204':
description: No content
/accounts/{account_id}/contacts:
get:
tags:
- Accounts
summary: List account contacts
operationId: Accounts_listAccountContacts
description: Lists the contacts associated with an Account
parameters:
- description: >-
The Account ID. Alternatively, you can supply the account domain or
external ID as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: account_id
required: true
schema:
type: string
default: acc_123
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/sortByCards'
- $ref: '#/components/parameters/sortOrder'
responses:
'200':
$ref: '#/components/responses/listOfContacts'
post:
tags:
- Accounts
summary: Add contact to Account
operationId: Accounts_addContactsToAccount
description: Adds a list of contacts to an Account
parameters:
- description: >-
The Account ID. Alternatively, you can supply the account domain or
external ID as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: account_id
required: true
schema:
type: string
default: acc_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactIds'
responses:
'204':
description: No content
delete:
tags:
- Accounts
summary: Remove contact from Account
operationId: Accounts_removeContactFrom
description: Removes a list of contacts from an Account
parameters:
- description: >-
The Account ID. Alternatively, you can supply the account domain or
external ID as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: account_id
required: true
schema:
type: string
default: acc_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactIds'
responses:
'204':
description: No content
/analytics/exports:
post:
tags:
- Analytics
summary: Create a new analytics export.
operationId: Analytics_createNewExport
description: >
Create a new analytics export of messages or events (activities) over a
specific time span.
The export will be executed asynchronously. The response will include a
link that can be used to retrieve the export status & result. Refer to
the [Analytics](https://dev.frontapp.com/reference/analytics) topic for
details about specific metrics.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsExportRequest'
responses:
'201':
description: An analytics export.
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsCreateNewExportResponse'
/analytics/exports/{export_id}:
get:
tags:
- Analytics
summary: Fetch an analytics export.
operationId: Analytics_getExport
description: >-
Fetch an analytics exports. Refer to the
[Analytics](https://dev.frontapp.com/reference/analytics) topic for
details about specific metrics.
parameters:
- description: The export ID.
in: path
name: export_id
required: true
schema:
type: string
default: exp_123
responses:
'200':
description: An analytics export.
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsGetExportResponse'
/analytics/reports:
post:
tags:
- Analytics
summary: Create a new analytics report.
operationId: Analytics_createNewReport
description: >
Create a new analytics report for a set of metrics over a specific time
span. Different filters (e.g. Inbox v Tag v Teammates) will be joined
with AND logic, but the IDs within a filter will be joined with OR logic
(e.g. Inbox A or Inbox B, Tag A or Tag B).
The report will be executed asynchronously. The response will include a
link that can be used to retrieve the
report status & result. Refer to the
[Analytics](https://dev.frontapp.com/reference/analytics) topic for
details about specific metrics.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsReportRequest'
responses:
'201':
description: An analytics report.
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsCreateNewReportResponse'
/analytics/reports/{report_uid}:
get:
tags:
- Analytics
summary: Fetch an analytics report.
operationId: Analytics_getReport
description: >-
Fetch an analytics report. Refer to the
[Analytics](https://dev.frontapp.com/reference/analytics) topic for
details about specific metrics.
parameters:
- description: The report UID.
in: path
name: report_uid
required: true
schema:
type: string
default: 723ec32796f12c6f05f6b124d8ef76191a38cec990e0f65d549206c51373f1a0
responses:
'200':
description: An analytics report.
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsGetReportResponse'
/channels:
get:
tags:
- Channels
summary: List channels
operationId: Channels_list
description: List the channels of the company.
responses:
'200':
$ref: '#/components/responses/listOfChannels'
/channels/{channel_id}:
get:
tags:
- Channels
summary: Get channel
operationId: Channels_getChannel
description: Fetch a channel.
parameters:
- description: >-
The Channel ID. Alternatively, you can supply the channel address as
a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: channel_id
required: true
schema:
type: string
default: cha_123
responses:
'200':
$ref: '#/components/responses/channel'
patch:
tags:
- Channels
summary: Update Channel
operationId: Channels_updateChannel
description: Update a channel.
parameters:
- description: >-
The Channel ID. Alternatively, you can supply the channel address as
a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: channel_id
required: true
schema:
type: string
default: cha_123
requestBody:
description: Channel details
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateChannel'
responses:
'204':
description: No content
/channels/{channel_id}/drafts:
post:
tags:
- Drafts
summary: Create draft
operationId: Drafts_createNewDraftMessage
description: >-
Create a draft message which is the first message of a new
[conversation](https://dev.frontapp.com/reference/conversations).
parameters:
- description: >-
The channel ID. Alternatively, you can supply the channel address as
a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: channel_id
required: true
schema:
type: string
default: cha_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDraft'
responses:
'200':
$ref: '#/components/responses/message'
/channels/{channel_id}/incoming_messages:
post:
tags:
- Messages
summary: Receive custom messages
operationId: Messages_receiveCustomMessage
description: >-
Receive a custom message in Front. This endpoint is available for custom
channels **ONLY**.
parameters:
- description: >-
The channel ID. Alternatively, you can supply the channel address as
a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: channel_id
required: true
schema:
type: string
default: cha_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomMessage'
responses:
'202':
$ref: '#/components/responses/acceptedMessage'
/channels/{channel_id}/messages:
post:
tags:
- Messages
summary: Create message
operationId: Messages_createNewMessage
description: >-
Send a new message from a channel. This is one of the ways to create a
new
[conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation).
The new conversation will support both messages and comments
(discussions).
parameters:
- description: >-
The sending channel ID. Alternatively, you can supply the sending
channel address as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: channel_id
required: true
schema:
type: string
default: cha_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OutboundMessage'
responses:
'202':
$ref: '#/components/responses/message'
/channels/{channel_id}/validate:
post:
tags:
- Channels
summary: Validate channel
operationId: Channels_validateSMTPSettings
description: >-
Asynchronously validate an SMTP channel (this endpoint is irrelevant to
other channel types). When you create an SMTP channel via the API,
[create a
channel](https://dev.frontapp.com/reference/post_inboxes-inbox-id-channels)
with type smtp and the send_as set to the needed email address. You then
[configure the email provider](https://help.front.com/en/articles/2081),
after which you use this endpoint to asynchronously validate the SMTP
settings.
parameters:
- description: >-
The Channel ID. Alternatively, you can supply the channel address as
a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: channel_id
required: true
schema:
type: string
default: cha_123
responses:
'202':
$ref: '#/components/responses/accepted'
/comments/{comment_id}:
patch:
tags:
- Comments
summary: Update comment
operationId: Comments_updateComment
description: >-
Update a comment in a
[conversation](https://dev.frontapp.com/reference/conversations).
parameters:
- description: The Comment ID
in: path
name: comment_id
required: true
schema:
type: string
default: com_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComment'
responses:
'200':
$ref: '#/components/responses/comment'
/comments/{comment_id}/mentions:
get:
tags:
- Comments
summary: List comment mentions
operationId: Comments_listMentionedTeammates
description: List the teammates mentioned in a comment.
parameters:
- description: The Comment ID
in: path
name: comment_id
required: true
schema:
type: string
default: com_123
responses:
'200':
$ref: '#/components/responses/listOfTeammates'
/company/rules:
get:
tags:
- Rules
summary: List all company rules
operationId: Rules_listAllCompanyRules
description: List the company rules.
responses:
'200':
$ref: '#/components/responses/listOfRules'
/company/tags:
get:
tags:
- Tags
summary: List company tags
operationId: Tags_listCompany
description: List the company tags.
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/sortByTags'
- $ref: '#/components/parameters/sortOrder'
responses:
'200':
$ref: '#/components/responses/listOfTags'
post:
tags:
- Tags
summary: Create company tag
operationId: Tags_createCompanyTag
description: Create a company tag.
requestBody:
description: Tag to create
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTag'
responses:
'201':
$ref: '#/components/responses/tag'
/contact_groups:
get:
tags:
- Contact Groups
summary: List groups
operationId: ContactGroups_listGroups
description: List the contact groups.
responses:
'200':
$ref: '#/components/responses/listOfContactGroups'
post:
tags:
- Contact Groups
summary: Create group
operationId: ContactGroups_createNewGroup
description: Create a new contact group in the default team (workspace).
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateContactGroup'
responses:
'204':
description: No content
/contact_groups/{contact_group_id}:
delete:
tags:
- Contact Groups
summary: Delete group
operationId: ContactGroups_deleteGroup
description: Delete a contact group.
parameters:
- description: The contact group ID
in: path
name: contact_group_id
required: true
schema:
type: string
default: grp_123
responses:
'204':
description: No content
/contact_groups/{contact_group_id}/contacts:
get:
tags:
- Contact Groups
summary: List contacts in group
operationId: ContactGroups_listGroupContacts
description: List the contacts belonging to the requested group.
parameters:
- description: The contact group ID
in: path
name: contact_group_id
required: true
schema:
type: string
default: grp_123
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/limit'
responses:
'200':
$ref: '#/components/responses/listOfContacts'
post:
tags:
- Contact Groups
summary: Add contacts to group
operationId: ContactGroups_addContactsToGroup
description: Add contacts to the requested group.
parameters:
- description: The contact group ID
in: path
name: contact_group_id
required: true
schema:
type: string
default: grp_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddContactsToGroup'
responses:
'204':
description: No content
delete:
tags:
- Contact Groups
summary: Remove contacts from group
operationId: ContactGroups_removeContacts
description: Remove contacts from the requested group.
parameters:
- description: The contact group ID
in: path
name: contact_group_id
required: true
schema:
type: string
default: grp_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveContactsFromGroup'
responses:
'204':
description: No content
/contacts:
get:
tags:
- Contacts
summary: List contacts
operationId: Contacts_listCompanyContacts
description: List the contacts of the company.
parameters:
- $ref: '#/components/parameters/cardQuery'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/sortByCards'
- $ref: '#/components/parameters/sortOrder'
responses:
'200':
$ref: '#/components/responses/listOfContacts'
post:
tags:
- Contacts
summary: Create contact
operationId: Contacts_createNewContact
description: Create a new contact.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateContact'
responses:
'201':
$ref: '#/components/responses/contact'
/contacts/custom_fields:
get:
tags:
- Custom Fields
summary: List Contact's custom fields
operationId: CustomFields_listContactFields
description: Lists the custom fields that can be attached to a Contact.
responses:
'200':
$ref: '#/components/responses/listOfCustomFields'
/contacts/merge:
post:
tags:
- Contacts
summary: Merge contacts
operationId: Contacts_mergeContacts
description: >
Merges the contacts specified into a single contact, deleting the
merged-in contacts.
If a target contact ID is supplied, the other contacts will be merged
into that one.
Otherwise, some contact in the contact ID list will be treated as the
target contact.
Merge conflicts will be resolved in the following ways:
* name will prioritize manually-updated and non-private contact names
* descriptions will be concatenated and separated by newlines in order from
oldest to newest with the (optional) target contact's description first
* all handles, groups, links, and notes will be preserved
* other conflicts will use the most recently updated contact's value
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MergeContacts'
responses:
'200':
$ref: '#/components/responses/contact'
/contacts/{contact_id}:
get:
tags:
- Contacts
summary: Get contact
operationId: Contacts_getOneContact
description: Fetch a contact.
parameters:
- description: >-
The contact ID. Alternatively, you can supply the contact's source
and handle as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: contact_id
required: true
schema:
type: string
default: crd_123
responses:
'200':
$ref: '#/components/responses/contact'
patch:
tags:
- Contacts
summary: Update a contact
operationId: Contacts_updateContact
description: Updates a contact.
parameters:
- description: >-
The contact ID. Alternatively, you can supply the contact's source
and handle as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: contact_id
required: true
schema:
type: string
default: crd_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Contact'
responses:
'204':
description: No content
delete:
tags:
- Contacts
summary: Delete a contact
operationId: Contacts_deleteContact
description: Delete a contact.
parameters:
- description: >-
The contact ID. Alternatively, you can supply the contact's source
and handle as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: contact_id
required: true
schema:
type: string
default: crd_123
responses:
'204':
description: No content
/contacts/{contact_id}/conversations:
get:
tags:
- Contacts
summary: List contact conversations
operationId: Contacts_listConversationsReverseChronologicalOrder
description: >
List the conversations for a contact in reverse chronological order
(newest first). For more advanced filtering, see the [search
endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
parameters:
- description: >-
The Contact ID. Alternatively, you can supply the contact's source
and handle as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: contact_id
required: true
schema:
type: string
default: crd_123
- $ref: '#/components/parameters/conversationQuery'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/pageToken'
responses:
'200':
$ref: '#/components/responses/listOfConversations'
/contacts/{contact_id}/handles:
post:
tags:
- Contact Handles
summary: Add contact handle
operationId: ContactHandles_addNewHandle
description: Adds a new handle to a contact.
parameters:
- description: >-
The contact ID. Alternatively, you can supply the contact's source
and handle as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: contact_id
required: true
schema:
type: string
default: crd_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactHandle'
responses:
'204':
description: No content
delete:
tags:
- Contact Handles
summary: Delete contact handle
operationId: ContactHandles_removeHandle
description: Remove a handle from a contact.
parameters:
- description: >-
The contact ID. Alternatively, you can supply the contact's source
and handle as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: contact_id
required: true
schema:
type: string
default: crd_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteContactHandle'
responses:
'204':
description: No content
/contacts/{contact_id}/notes:
get:
tags:
- Contact Notes
summary: List notes
operationId: ContactNotes_list
description: List the notes added to a contact.
parameters:
- description: >-
The contact ID. Alternatively, you can supply the contact's source
and handle as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: contact_id
required: true
schema:
type: string
default: crd_123
responses:
'202':
$ref: '#/components/responses/listOfContactNotes'
post:
tags:
- Contact Notes
summary: Add note
operationId: ContactNotes_createNewNote
description: Create a new note on a contact.
parameters:
- description: >-
The contact ID. Alternatively, you can supply the contact's source
and handle as a [resource
alias](https://dev.frontapp.com/docs/resource-aliases-1).
in: path
name: contact_id
required: true
schema:
type: string
default: crd_123
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateContactNote'
responses:
'201':
$ref: '#/components/responses/contactNote'
/conversations:
get:
tags:
- Conversations
summary: List conversations
operationId: Conversations_listInReverseChronologicalOrder
description: >
List the conversations in the company in reverse chronological order
(most recently updated first). The order will respect your company's
[bump
settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up),
which determine when conversations bump to the top. For more advanced
filtering, see the [search
endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
parameters:
- $ref: '#/components/parameters/conversationQuery'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/sortByConversations'
- $ref: '#/components/parameters/sortOrder'
responses:
'200':
$ref: '#/components/responses/listOfConversations'
post:
tags:
- Conversations
summary: Create discussion conversation
operationId: Conversations_createDiscussion
description: >-
Create a new
[conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation)
that only supports comments (known as discussions in Front). If you want
to create a conversation that supports messages, use the [Create
message](https://dev.frontapp.com/reference/post_channels-channel-id-messages)
endpoint. If you want to add a comment to an existing conversation, use
the [Add
comment](https://dev.frontapp.com/reference/post_conversations-conversation-id-comments)