Skip to content

Commit 4085fbb

Browse files
dan0505dan0505
committed
add package_package_code to conversation_part and ticket_part
1 parent 6a9c54f commit 4085fbb

File tree

1 file changed

+35
-5
lines changed

1 file changed

+35
-5
lines changed

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3754,10 +3754,10 @@ paths:
37543754
operationId: UpdateContact
37553755
description: |
37563756
You can update an existing contact (ie. user or lead).
3757-
3757+
37583758
{% admonition type="info" %}
37593759
This endpoint handles both **contact updates** and **custom object associations**.
3760-
3760+
37613761
See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format.
37623762
{% /admonition %}
37633763
responses:
@@ -5432,6 +5432,7 @@ paths:
54325432
id: '123456'
54335433
name: Test tag
54345434
event_details:
5435+
app_package_code: null
54355436
- type: conversation_part
54365437
id: 2
54375438
part_type: custom_action_started
@@ -5454,6 +5455,7 @@ paths:
54545455
event_details:
54555456
action:
54565457
name: Jira Create Issue
5458+
app_package_code: test-integration
54575459
- type: conversation_part
54585460
id: 3
54595461
part_type: conversation_attribute_updated_by_admin
@@ -5478,6 +5480,7 @@ paths:
54785480
name: jira_issue_key
54795481
value:
54805482
name: PROJ-007
5483+
app_package_code: null
54815484
- type: conversation_part
54825485
id: 4
54835486
part_type: custom_action_finished
@@ -5501,6 +5504,7 @@ paths:
55015504
action:
55025505
name: Jira Create Issue
55035506
result: success
5507+
app_package_code: null
55045508
total_count: 4
55055509
schema:
55065510
"$ref": "#/components/schemas/conversation"
@@ -5581,7 +5585,7 @@ paths:
55815585

55825586
{% admonition type="info" %}
55835587
This endpoint handles both **conversation updates** and **custom object associations**.
5584-
5588+
55855589
See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format.
55865590
{% /admonition %}
55875591

@@ -5668,6 +5672,7 @@ paths:
56685672
redacted: false
56695673
metadata: {}
56705674
email_message_metadata:
5675+
app_package_code: null
56715676
- type: conversation_part
56725677
id: '130'
56735678
part_type: conversation_attribute_updated_by_admin
@@ -5686,6 +5691,7 @@ paths:
56865691
redacted: false
56875692
metadata: {}
56885693
email_message_metadata:
5694+
app_package_code: null
56895695
total_count: 2
56905696
update a conversation with an association to a custom object instance:
56915697
value:
@@ -6187,6 +6193,7 @@ paths:
61876193
redacted: false
61886194
metadata: {}
61896195
email_message_metadata:
6196+
app_package_code: null
61906197
total_count: 1
61916198
Admin note reply:
61926199
value:
@@ -6274,6 +6281,7 @@ paths:
62746281
redacted: false
62756282
metadata: {}
62766283
email_message_metadata:
6284+
app_package_code: null
62776285
total_count: 1
62786286
Admin quick_reply reply:
62796287
value:
@@ -6349,6 +6357,7 @@ paths:
63496357
redacted: false
63506358
metadata: {}
63516359
email_message_metadata:
6360+
app_package_code: null
63526361
total_count: 1
63536362
User last conversation reply:
63546363
value:
@@ -6427,6 +6436,7 @@ paths:
64276436
redacted: false
64286437
metadata: {}
64296438
email_message_metadata:
6439+
app_package_code: null
64306440
total_count: 1
64316441
schema:
64326442
"$ref": "#/components/schemas/conversation"
@@ -6624,6 +6634,7 @@ paths:
66246634
redacted: false
66256635
metadata: {}
66266636
email_message_metadata:
6637+
app_package_code: null
66276638
total_count: 1
66286639
Snooze a conversation:
66296640
value:
@@ -6699,6 +6710,7 @@ paths:
66996710
redacted: false
67006711
metadata: {}
67016712
email_message_metadata:
6713+
app_package_code: null
67026714
total_count: 1
67036715
Open a conversation:
67046716
value:
@@ -6774,6 +6786,7 @@ paths:
67746786
redacted: false
67756787
metadata: {}
67766788
email_message_metadata:
6789+
app_package_code: null
67776790
total_count: 1
67786791
Assign a conversation:
67796792
value:
@@ -6851,6 +6864,7 @@ paths:
68516864
redacted: false
68526865
metadata: {}
68536866
email_message_metadata:
6867+
app_package_code: null
68546868
total_count: 1
68556869
schema:
68566870
"$ref": "#/components/schemas/conversation"
@@ -7275,6 +7289,7 @@ paths:
72757289
redacted: true
72767290
metadata: {}
72777291
email_message_metadata:
7292+
app_package_code: null
72787293
total_count: 1
72797294
schema:
72807295
"$ref": "#/components/schemas/conversation"
@@ -7402,6 +7417,7 @@ paths:
74027417
email: joe@bloggs.com
74037418
attachments: []
74047419
redacted: false
7420+
app_package_code: test-integration
74057421
- type: ticket_part
74067422
id: '152'
74077423
part_type: ticket_state_updated_by_admin
@@ -7416,6 +7432,7 @@ paths:
74167432
email: operator+this_is_an_id442_that_should_be_at_least_@intercom.io
74177433
attachments: []
74187434
redacted: false
7435+
app_package_code: test-integration
74197436
total_count: 2
74207437
open: true
74217438
linked_objects:
@@ -11044,6 +11061,7 @@ paths:
1104411061
email: admin419@email.com
1104511062
attachments: []
1104611063
redacted: false
11064+
app_package_code: test-integration
1104711065
Admin quick_reply reply:
1104811066
value:
1104911067
type: ticket_part
@@ -11637,6 +11655,7 @@ paths:
1163711655
email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io
1163811656
attachments: []
1163911657
redacted: false
11658+
app_package_code: test-integration
1164011659
- type: ticket_part
1164111660
id: '180'
1164211661
part_type: assignment
@@ -11879,6 +11898,7 @@ paths:
1187911898
email: admin509@email.com
1188011899
attachments: []
1188111900
redacted: false
11901+
app_package_code: test-integration
1188211902
total_count: 1
1188311903
open: true
1188411904
linked_objects:
@@ -15132,6 +15152,11 @@ components:
1513215152
event_details:
1513315153
"$ref": "#/components/schemas/event_details"
1513415154
nullable: true
15155+
app_package_code:
15156+
type: string
15157+
nullable: true
15158+
example: "test-integraion"
15159+
description: The app package code if this part was created via API. null if the part was not created via API.
1513515160
conversation_part_author:
1513615161
title: Conversation part author
1513715162
type: object
@@ -15180,7 +15205,7 @@ components:
1518015205
total_count:
1518115206
type: integer
1518215207
description: ''
15183-
example: 2
15208+
example: 1
1518415209
conversation_rating:
1518515210
title: Conversation Rating
1518615211
type: object
@@ -18767,6 +18792,11 @@ components:
1876718792
type: boolean
1876818793
description: Whether or not the ticket part has been redacted.
1876918794
example: false
18795+
app_package_code:
18796+
type: string
18797+
nullable: false
18798+
example: text-integration
18799+
description: The app package code if this part was created via API. Note this field won't show if the part was not created via API.
1877018800
ticket_part_author:
1877118801
title: Ticket part author
1877218802
type: object
@@ -20011,7 +20041,7 @@ tags:
2001120041
description: What is a conversation?
2001220042
url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation
2001320043
- name: Custom Object Instances
20014-
description: |
20044+
description: |
2001520045
Everything about your Custom Object instances.
2001620046
{% admonition type="warning" name="Permission Requirements" %}
2001720047
From now on, to access this endpoint, you need additional permissions. Please head over to the [Developer Hub](https://app.intercom.com/a/apps/_/developer-hub) app package authentication settings to configure the required permissions.

0 commit comments

Comments
 (0)