Skip to content

Commit 7a880c5

Browse files
VarshSureshclaude
andcommitted
Sync bulk contacts examples and error codes with developer-docs
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent f1ffb81 commit 7a880c5

1 file changed

Lines changed: 29 additions & 33 deletions

File tree

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

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -9210,7 +9210,7 @@ paths:
92109210
{% admonition type="info" name="Handling existing contacts" %}
92119211
If a contact already exists with the given `external_id` or `email` (including an archived contact), that item is rejected and the job's `state` ends as `completed_with_errors`. New contacts in the same request are still created. The job `state` from `GET /contacts/bulk/{id}` is the signal that one or more items were rejected.
92129212

9213-
Created contacts aren't returned with IDs in the response. Look them up afterwards with [Get a contact by External ID](/docs/references/preview/rest-api/api.intercom.io/contacts/getcontactbyexternalid) or [Search contacts](/docs/references/preview/rest-api/api.intercom.io/contacts/searchcontacts).
9213+
Created contacts aren't returned with IDs in the response. Look them up afterwards with [Get a contact by External ID](/docs/references/preview/rest-api/api.intercom.io/contacts/showcontactbyexternalid) or [Search contacts](/docs/references/preview/rest-api/api.intercom.io/contacts/searchcontacts).
92149214
{% /admonition %}
92159215

92169216
{% admonition type="info" name="Limits" %}
@@ -9225,17 +9225,6 @@ paths:
92259225
examples:
92269226
successful:
92279227
summary: Successful
9228-
value:
9229-
contacts:
9230-
- external_id: abc123
9231-
email: joe@bloggs.com
9232-
name: Joe Bloggs
9233-
- external_id: def456
9234-
email: maria@example.com
9235-
name: "María García"
9236-
role: lead
9237-
all_fields:
9238-
summary: All supported fields
92399228
value:
92409229
contacts:
92419230
- external_id: abc123
@@ -9273,6 +9262,15 @@ paths:
92739262
company:
92749263
company_id: '6'
92759264
name: Blue Sun
9265+
append_to_existing_job:
9266+
summary: Append to existing job
9267+
value:
9268+
contacts:
9269+
- external_id: abc123
9270+
email: joe@bloggs.com
9271+
language_override: de
9272+
job:
9273+
id: job_v2_1
92769274
responses:
92779275
'202':
92789276
description: Accepted
@@ -9321,14 +9319,14 @@ paths:
93219319
type: error.list
93229320
request_id: 2859da57-c83f-405c-8166-240a312442a3
93239321
errors:
9324-
- code: missing_field
9322+
- code: field_not_found
93259323
message: contacts field must be supplied
93269324
too_many_contacts:
93279325
value:
93289326
type: error.list
93299327
request_id: 2859da57-c83f-405c-8166-240a312442a3
93309328
errors:
9331-
- code: invalid_parameter
9329+
- code: parameter_invalid
93329330
message: maximum number of contacts per request is 100
93339331
schema:
93349332
"$ref": "#/components/schemas/error"
@@ -9361,18 +9359,7 @@ paths:
93619359
"$ref": "#/components/schemas/bulk_update_contacts_request"
93629360
examples:
93639361
successful:
9364-
summary: Successful
9365-
value:
9366-
contacts:
9367-
- id: abc123
9368-
language_override: fr
9369-
- id: def456
9370-
name: Updated Name
9371-
- id: ghi789
9372-
language_override: es
9373-
name: "María García"
9374-
all_fields:
9375-
summary: All supported fields
9362+
summary: successful
93769363
value:
93779364
contacts:
93789365
- id: abc123
@@ -9392,6 +9379,8 @@ paths:
93929379
tags:
93939380
add:
93949381
- id: '123'
9382+
remove:
9383+
- id: '987'
93959384
with_companies:
93969385
summary: Attach and detach companies
93979386
value:
@@ -9473,21 +9462,21 @@ paths:
94739462
type: error.list
94749463
request_id: 2859da57-c83f-405c-8166-240a312442a3
94759464
errors:
9476-
- code: missing_field
9465+
- code: field_not_found
94779466
message: contacts field must be supplied
94789467
missing_id:
94799468
value:
94809469
type: error.list
94819470
request_id: 2859da57-c83f-405c-8166-240a312442a3
94829471
errors:
9483-
- code: missing_field
9472+
- code: field_not_found
94849473
message: contacts must be identified by id
94859474
too_many_contacts:
94869475
value:
94879476
type: error.list
94889477
request_id: 2859da57-c83f-405c-8166-240a312442a3
94899478
errors:
9490-
- code: invalid_parameter
9479+
- code: parameter_invalid
94919480
message: maximum number of contacts per request is 100
94929481
schema:
94939482
"$ref": "#/components/schemas/error"
@@ -9503,7 +9492,7 @@ paths:
95039492
- Contacts
95049493
operationId: BulkDeleteContacts
95059494
description: |
9506-
You can permanently delete contacts in bulk by submitting an array of contact `id`s.
9495+
You can delete contacts in bulk by submitting an array of contact `id`s.
95079496

95089497
The endpoint creates an async job that processes the deletes in the background. Use the returned job ID with `GET /contacts/bulk/{id}` to check the job status.
95099498

@@ -9527,6 +9516,13 @@ paths:
95279516
contacts:
95289517
- id: abc123
95299518
- id: def456
9519+
append_to_existing_job:
9520+
summary: Append to existing job
9521+
value:
9522+
contacts:
9523+
- id: abc123
9524+
job:
9525+
id: job_v2_1
95309526
responses:
95319527
'202':
95329528
description: Accepted
@@ -9575,21 +9571,21 @@ paths:
95759571
type: error.list
95769572
request_id: 2859da57-c83f-405c-8166-240a312442a3
95779573
errors:
9578-
- code: missing_field
9574+
- code: field_not_found
95799575
message: contacts field must be supplied
95809576
missing_id:
95819577
value:
95829578
type: error.list
95839579
request_id: 2859da57-c83f-405c-8166-240a312442a3
95849580
errors:
9585-
- code: missing_field
9581+
- code: field_not_found
95869582
message: contacts must be identified by id
95879583
too_many_contacts:
95889584
value:
95899585
type: error.list
95909586
request_id: 2859da57-c83f-405c-8166-240a312442a3
95919587
errors:
9592-
- code: invalid_parameter
9588+
- code: parameter_invalid
95939589
message: maximum number of contacts per request is 100
95949590
schema:
95959591
"$ref": "#/components/schemas/error"

0 commit comments

Comments
 (0)