Skip to content

Commit 82dea58

Browse files
VarshSureshVarshSuresh
authored
Update docs of associating CO with contacts (#216)
1 parent 072e265 commit 82dea58

File tree

1 file changed

+141
-5
lines changed

1 file changed

+141
-5
lines changed

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

Lines changed: 141 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3750,8 +3750,16 @@ paths:
37503750
type: string
37513751
tags:
37523752
- Contacts
3753+
- Custom Object Instances
37533754
operationId: UpdateContact
3754-
description: You can update an existing contact (ie. user or lead).
3755+
description: |
3756+
You can update an existing contact (ie. user or lead).
3757+
3758+
{% admonition type="info" %}
3759+
This endpoint handles both **contact updates** and **custom object associations**.
3760+
3761+
See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format.
3762+
{% /admonition %}
37553763
responses:
37563764
'200':
37573765
description: successful
@@ -3847,6 +3855,106 @@ paths:
38473855
utm_term:
38483856
referrer:
38493857
enabled_push_messaging:
3858+
update a contact with an association to a custom object instance:
3859+
value:
3860+
type: contact
3861+
id: 6762f0cd1bb69f9f2193bb7c
3862+
workspace_id: this_is_an_id279_that_should_be_at_least_
3863+
external_id: '70'
3864+
role: user
3865+
email: joebloggs@intercom.io
3866+
phone:
3867+
formatted_phone:
3868+
name: joe bloggs
3869+
avatar:
3870+
owner_id:
3871+
social_profiles:
3872+
type: list
3873+
data: []
3874+
has_hard_bounced: false
3875+
marked_email_as_spam: false
3876+
unsubscribed_from_emails: false
3877+
created_at: 1734537421
3878+
updated_at: 1734537422
3879+
signed_up_at: 1734537421
3880+
last_seen_at:
3881+
last_replied_at:
3882+
last_contacted_at:
3883+
last_email_opened_at:
3884+
last_email_clicked_at:
3885+
language_override:
3886+
browser:
3887+
browser_version:
3888+
browser_language:
3889+
os:
3890+
location:
3891+
type: location
3892+
country:
3893+
region:
3894+
city:
3895+
country_code:
3896+
continent_code:
3897+
android_app_name:
3898+
android_app_version:
3899+
android_device:
3900+
android_os_version:
3901+
android_sdk_version:
3902+
android_last_seen_at:
3903+
ios_app_name:
3904+
ios_app_version:
3905+
ios_device:
3906+
ios_os_version:
3907+
ios_sdk_version:
3908+
ios_last_seen_at:
3909+
custom_attributes:
3910+
order:
3911+
type: Order.list
3912+
instances:
3913+
- id: '21'
3914+
external_id: '123'
3915+
external_created_at: 1392036272
3916+
external_updated_at: 1392036272
3917+
custom_attributes:
3918+
order_number: ORDER-12345
3919+
total_amount: 99.99
3920+
type: Order
3921+
tags:
3922+
type: list
3923+
data: []
3924+
url: "/contacts/6762f0cd1bb69f9f2193bb7c/tags"
3925+
total_count: 0
3926+
has_more: false
3927+
notes:
3928+
type: list
3929+
data: []
3930+
url: "/contacts/6762f0cd1bb69f9f2193bb7c/notes"
3931+
total_count: 0
3932+
has_more: false
3933+
companies:
3934+
type: list
3935+
data: []
3936+
url: "/contacts/6762f0cd1bb69f9f2193bb7c/companies"
3937+
total_count: 0
3938+
has_more: false
3939+
opted_out_subscription_types:
3940+
type: list
3941+
data: []
3942+
url: "/contacts/6762f0cd1bb69f9f2193bb7c/subscriptions"
3943+
total_count: 0
3944+
has_more: false
3945+
opted_in_subscription_types:
3946+
type: list
3947+
data: []
3948+
url: "/contacts/6762f0cd1bb69f9f2193bb7c/subscriptions"
3949+
total_count: 0
3950+
has_more: false
3951+
utm_campaign:
3952+
utm_content:
3953+
utm_medium:
3954+
utm_source:
3955+
utm_term:
3956+
referrer:
3957+
enabled_push_messaging:
38503958
schema:
38513959
allOf:
38523960
- "$ref": "#/components/schemas/contact"
@@ -3882,6 +3990,13 @@ paths:
38823990
value:
38833991
email: joebloggs@intercom.io
38843992
name: joe bloggs
3993+
update_a_contact_with_an_association_to_a_custom_object_instance:
3994+
summary: update a contact with an association to a custom object
3995+
instance
3996+
value:
3997+
custom_attributes:
3998+
order:
3999+
- '21'
38854000
get:
38864001
summary: Get a contact
38874002
parameters:
@@ -5454,6 +5569,7 @@ paths:
54545569
type: string
54555570
tags:
54565571
- Conversations
5572+
- Custom Object Instances
54575573
operationId: updateConversation
54585574
description: |2+
54595575

@@ -5463,6 +5579,12 @@ paths:
54635579
If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.
54645580
{% /admonition %}
54655581

5582+
{% admonition type="info" %}
5583+
This endpoint handles both **conversation updates** and **custom object associations**.
5584+
5585+
See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format.
5586+
{% /admonition %}
5587+
54665588
responses:
54675589
'200':
54685590
description: update a conversation with an association to a custom object
@@ -5610,11 +5732,16 @@ paths:
56105732
title:
56115733
custom_attributes:
56125734
order:
5613-
type: order.list
5735+
type: Order.list
56145736
instances:
56155737
- id: '21'
5616-
custom_attributes: {}
5617-
type: order
5738+
external_id: '123'
5739+
external_created_at: 1392036272
5740+
external_updated_at: 1392036272
5741+
custom_attributes:
5742+
order_number: ORDER-12345
5743+
total_amount: 99.99
5744+
type: Order
56185745
topics: {}
56195746
ticket:
56205747
linked_objects:
@@ -7347,6 +7474,7 @@ paths:
73477474
"$ref": "#/components/schemas/intercom_version"
73487475
tags:
73497476
- Custom Object Instances
7477+
operationId: createCustomObjectInstances
73507478
description: Create or update a custom object instance
73517479
responses:
73527480
'200':
@@ -7410,6 +7538,7 @@ paths:
74107538
"$ref": "#/components/schemas/intercom_version"
74117539
tags:
74127540
- Custom Object Instances
7541+
operationId: getCustomObjectInstancesByExternalId
74137542
description: Fetch a Custom Object Instance by external_id.
74147543
responses:
74157544
'200':
@@ -7458,6 +7587,7 @@ paths:
74587587
"$ref": "#/components/schemas/intercom_version"
74597588
tags:
74607589
- Custom Object Instances
7590+
operationId: deleteCustomObjectInstancesById
74617591
description: Delete a single Custom Object instance by external_id.
74627592
responses:
74637593
'200':
@@ -7501,6 +7631,7 @@ paths:
75017631
"$ref": "#/components/schemas/intercom_version"
75027632
tags:
75037633
- Custom Object Instances
7634+
operationId: getCustomObjectInstancesById
75047635
description: Fetch a Custom Object Instance by id.
75057636
responses:
75067637
'200':
@@ -7541,6 +7672,7 @@ paths:
75417672
"$ref": "#/components/schemas/intercom_version"
75427673
tags:
75437674
- Custom Object Instances
7675+
operationId: deleteCustomObjectInstancesByExternalId
75447676
description: Delete a single Custom Object instance using the Intercom defined
75457677
id.
75467678
responses:
@@ -19879,7 +20011,11 @@ tags:
1987920011
description: What is a conversation?
1988020012
url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation
1988120013
- name: Custom Object Instances
19882-
description: Everything about your Custom Object instances.
20014+
description: |
20015+
Everything about your Custom Object instances.
20016+
{% admonition type="warning" name="Permission Requirements" %}
20017+
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.
20018+
{% /admonition %}
1988320019
- name: Data Attributes
1988420020
description: Everything about your Data Attributes
1988520021
- name: Data Events

0 commit comments

Comments
 (0)