You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 7a880c5
Browse filesBrowse the repository at this point in the historyBrowse files
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.
9212
9212
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).
9214
9214
{% /admonition %}
9215
9215
9216
9216
{% admonition type="info" name="Limits" %}
@@ -9225,17 +9225,6 @@ paths:
9225
9225
examples:
9226
9226
successful:
9227
9227
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
9239
9228
value:
9240
9229
contacts:
9241
9230
- external_id: abc123
@@ -9273,6 +9262,15 @@ paths:
9273
9262
company:
9274
9263
company_id: '6'
9275
9264
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
9276
9274
responses:
9277
9275
'202':
9278
9276
description: Accepted
@@ -9321,14 +9319,14 @@ paths:
9321
9319
type: error.list
9322
9320
request_id: 2859da57-c83f-405c-8166-240a312442a3
9323
9321
errors:
9324
-
- code: missing_field
9322
+
- code: field_not_found
9325
9323
message: contacts field must be supplied
9326
9324
too_many_contacts:
9327
9325
value:
9328
9326
type: error.list
9329
9327
request_id: 2859da57-c83f-405c-8166-240a312442a3
9330
9328
errors:
9331
-
- code: invalid_parameter
9329
+
- code: parameter_invalid
9332
9330
message: maximum number of contacts per request is 100
message: maximum number of contacts per request is 100
9492
9481
schema:
9493
9482
"$ref": "#/components/schemas/error"
@@ -9503,7 +9492,7 @@ paths:
9503
9492
- Contacts
9504
9493
operationId: BulkDeleteContacts
9505
9494
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.
9507
9496
9508
9497
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.
9509
9498
@@ -9527,6 +9516,13 @@ paths:
9527
9516
contacts:
9528
9517
- id: abc123
9529
9518
- 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
9530
9526
responses:
9531
9527
'202':
9532
9528
description: Accepted
@@ -9575,21 +9571,21 @@ paths:
9575
9571
type: error.list
9576
9572
request_id: 2859da57-c83f-405c-8166-240a312442a3
9577
9573
errors:
9578
-
- code: missing_field
9574
+
- code: field_not_found
9579
9575
message: contacts field must be supplied
9580
9576
missing_id:
9581
9577
value:
9582
9578
type: error.list
9583
9579
request_id: 2859da57-c83f-405c-8166-240a312442a3
9584
9580
errors:
9585
-
- code: missing_field
9581
+
- code: field_not_found
9586
9582
message: contacts must be identified by id
9587
9583
too_many_contacts:
9588
9584
value:
9589
9585
type: error.list
9590
9586
request_id: 2859da57-c83f-405c-8166-240a312442a3
9591
9587
errors:
9592
-
- code: invalid_parameter
9588
+
- code: parameter_invalid
9593
9589
message: maximum number of contacts per request is 100
0 commit comments