Skip to content

Document attaching custom object instances to a contact (PUT /contacts/{id}) #594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MatthewPelyhes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document attaching custom object instances to a contact (PUT /contacts/{id}) #594

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7592,7 +7592,7 @@ paths:
{% admonition type="info" %}
This endpoint handles both **contact updates** and **custom object associations**.

See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format.
To associate custom object instances, set the relationship custom attribute under `custom_attributes` to the instance id (to-one) or an array of instance ids (to-many). See the _`attach a single custom object instance`_ and _`attach multiple custom object instances`_ request examples, and the _`update a contact with an association to a custom object instance`_ response example, for the custom object association format.
{% /admonition %}
responses:
'200':
Expand Down Expand Up @@ -7824,13 +7824,18 @@ paths:
value:
email: joebloggs@intercom.io
name: joe bloggs
update_a_contact_with_an_association_to_a_custom_object_instance:
summary: update a contact with an association to a custom object
instance
attach a single custom object instance:
summary: attach a single custom object instance
value:
custom_attributes:
order: '21'
attach multiple custom object instances:
summary: attach multiple custom object instances
value:
custom_attributes:
order:
- '21'
- '22'
get:
summary: Get a contact
parameters:
Expand Down Expand Up @@ -38009,7 +38014,10 @@ components:
custom_attributes:
type: object
nullable: true
description: The custom attributes which are set for the contact
description: |
The custom attributes which are set for the contact.

When a custom attribute is a relationship to a custom object type, its value is the id (or ids) of the custom object instance(s) to associate. Use a single id string for a to-one (has-one) relationship, or an array of id strings for a to-many (has-many) relationship. For a to-many relationship the array replaces the entire set, so omitted ids are detached. The response surfaces the association under `custom_attributes.<attribute>` as `{ "type": "<Type>.list", "instances": [...] }`.
update_content_import_source_request:
title: Create Content Import Source Payload
type: object
Expand Down