From 6e49b0763ebedb828984a8e676cc37392a1288ba Mon Sep 17 00:00:00 2001 From: Cyril Duchon-Doris Date: Thu, 16 Nov 2023 17:53:21 +0100 Subject: [PATCH] chore: clarify IDs and explain how to create a company Add create example Add information regarding intercom IDs --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 8ad928a..aa81eca 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,8 @@ https://api.intercom.io/export/content/data #### Contacts Note that this is a new resource compatible only with the new [Contacts API](https://developers.intercom.com/intercom-api-reference/reference#contacts-model) released in API v2.0. +- `user_id` refers to an attribute that you would have on your side to identify your users +- `user.id` refers to the internal ID used by intercom to identify users ```ruby # Create a contact with "lead" role @@ -198,7 +200,15 @@ intercom.visitors.convert(visitor, user) #### Companies +Note that +- "company_id" refers to an attribute that you would have on your side +- company.id refers to the internal company ID used by Intercom + + ```ruby +# Create a company +company = intercom.companies.create(name: 'Intercom', company_id: 42) + # Find a company by company_id company = intercom.companies.find(company_id: "44")