Skip to content

Commit 66488e7

Browse files
committed
Align bulk contact create/update fields with the single contact endpoints
Adds avatar, owner_id, unsubscribed_from_emails, and tags (add/remove) to bulk create/update request bodies to match the single contact create/update endpoints. Renames the update identifier field to external_id and owner_id to string to match the rest of the contact schemas, drops the undocumented companies/company properties, and clarifies tag id requirements and best-effort application behavior.
1 parent ff88654 commit 66488e7

1 file changed

Lines changed: 41 additions & 35 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 41 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -26958,6 +26958,10 @@ components:
2695826958
phone:
2695926959
type: string
2696026960
description: The contact's phone number.
26961+
avatar:
26962+
type: string
26963+
description: An image URL containing the avatar of the contact.
26964+
example: https://www.example.com/avatar_image.jpg
2696126965
language_override:
2696226966
type: string
2696326967
description: A preferred language setting for the contact, used by
@@ -26973,6 +26977,32 @@ components:
2697326977
type: integer
2697426978
description: The time the contact was last seen, in Unix timestamp
2697526979
format.
26980+
owner_id:
26981+
type: string
26982+
description: The ID of an admin that has been assigned account ownership
26983+
of the contact.
26984+
example: "321"
26985+
unsubscribed_from_emails:
26986+
type: boolean
26987+
description: Whether the contact is unsubscribed from emails.
26988+
example: true
26989+
tags:
26990+
type: object
26991+
description: |
26992+
Tags to add to the contact. Each tag is identified by its `id`, which must be a positive integer for a tag that already exists in your workspace. Tag application is best-effort: unknown tag IDs are skipped while the rest of the contact create still applies. Per-tag results are not yet returned in the job status.
26993+
properties:
26994+
add:
26995+
type: array
26996+
description: Tags to add to the contact.
26997+
items:
26998+
type: object
26999+
required:
27000+
- id
27001+
properties:
27002+
id:
27003+
type: string
27004+
description: The ID of an existing tag to add to the contact.
27005+
example: '123'
2697627006
job:
2697727007
type: object
2697827008
description: Optional. Include to append tasks to an existing job.
@@ -27044,55 +27074,31 @@ components:
2704427074
description: A preferred language setting for the contact, used by
2704527075
the Intercom Messenger.
2704627076
example: fr
27047-
user_id:
27077+
external_id:
2704827078
type: string
27049-
description: A unique identifier for the contact that you provide. Maps to the contact's external user ID.
27050-
example: '25'
27079+
description: A unique identifier for the contact which you have
27080+
defined.
27081+
example: abc123
2705127082
phone:
2705227083
type: string
2705327084
description: The contact's phone number.
2705427085
example: "+353871234567"
2705527086
owner_id:
27056-
type: integer
27057-
description: The ID of the teammate who owns the contact.
27058-
example: 123
27087+
type: string
27088+
description: The ID of an admin that has been assigned account ownership
27089+
of the contact.
27090+
example: "321"
2705927091
unsubscribed_from_emails:
2706027092
type: boolean
2706127093
description: Whether the contact is unsubscribed from emails.
2706227094
example: true
2706327095
avatar:
2706427096
type: string
27065-
description: An image URL for the contact's avatar. You can also pass an object with an `image_url` field.
27066-
example: https://www.example.com/avatar.png
27097+
description: An image URL containing the avatar of the contact.
27098+
example: https://www.example.com/avatar_image.jpg
2706727099
custom_attributes:
2706827100
type: object
2706927101
description: Custom attributes to update on the contact.
27070-
companies:
27071-
type: array
27072-
description: A list of companies to associate with the contact. Each company is identified by the `company_id` you have defined. Companies that do not exist are created.
27073-
items:
27074-
type: object
27075-
properties:
27076-
company_id:
27077-
type: string
27078-
description: The company ID you have defined for the company.
27079-
example: '6'
27080-
name:
27081-
type: string
27082-
description: The name of the company.
27083-
example: Blue Sun
27084-
company:
27085-
type: object
27086-
description: A single company to associate with the contact, identified by the `company_id` you have defined. Created if it does not exist.
27087-
properties:
27088-
company_id:
27089-
type: string
27090-
description: The company ID you have defined for the company.
27091-
example: '6'
27092-
name:
27093-
type: string
27094-
description: The name of the company.
27095-
example: Blue Sun
2709627102
tags:
2709727103
type: object
2709827104
description: |
@@ -27121,7 +27127,7 @@ components:
2712127127
id:
2712227128
type: string
2712327129
description: The ID of an existing tag to remove from the contact.
27124-
example: '456'
27130+
example: '789'
2712527131
job:
2712627132
type: object
2712727133
description: Optional. Include to append tasks to an existing job.

0 commit comments

Comments
 (0)