Skip to content

Commit 23c85d2

Browse files
VarshSureshclaude
andcommitted
Document 404 job_not_found and 422 type_mismatch on bulk contacts (Preview)
The bulk contacts endpoints raise two error responses that were not documented. Both are asserted in the monolith's controller specs but absent from the spec, so integrators had no way to know to handle them. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 60e3c8a commit 23c85d2

1 file changed

Lines changed: 84 additions & 0 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9466,6 +9466,20 @@ paths:
94669466
message: Access Token Invalid
94679467
schema:
94689468
"$ref": "#/components/schemas/error"
9469+
'404':
9470+
description: Not Found
9471+
content:
9472+
application/json:
9473+
examples:
9474+
job_not_found:
9475+
value:
9476+
type: error.list
9477+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9478+
errors:
9479+
- code: job_not_found
9480+
message: job job_v2_1 not found
9481+
schema:
9482+
"$ref": "#/components/schemas/error"
94699483
'422':
94709484
description: Unprocessable Entity
94719485
content:
@@ -9485,6 +9499,20 @@ paths:
94859499
errors:
94869500
- code: parameter_invalid
94879501
message: maximum number of contacts per request is 100
9502+
contacts_not_an_array:
9503+
value:
9504+
type: error.list
9505+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9506+
errors:
9507+
- code: type_mismatch
9508+
message: contacts must be an array
9509+
contact_not_an_object:
9510+
value:
9511+
type: error.list
9512+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9513+
errors:
9514+
- code: type_mismatch
9515+
message: each contact must be an object
94889516
schema:
94899517
"$ref": "#/components/schemas/error"
94909518
put:
@@ -9605,6 +9633,20 @@ paths:
96059633
message: Access Token Invalid
96069634
schema:
96079635
"$ref": "#/components/schemas/error"
9636+
'404':
9637+
description: Not Found
9638+
content:
9639+
application/json:
9640+
examples:
9641+
job_not_found:
9642+
value:
9643+
type: error.list
9644+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9645+
errors:
9646+
- code: job_not_found
9647+
message: job job_v2_1 not found
9648+
schema:
9649+
"$ref": "#/components/schemas/error"
96089650
'422':
96099651
description: Unprocessable Entity
96109652
content:
@@ -9631,6 +9673,20 @@ paths:
96319673
errors:
96329674
- code: parameter_invalid
96339675
message: maximum number of contacts per request is 100
9676+
contacts_not_an_array:
9677+
value:
9678+
type: error.list
9679+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9680+
errors:
9681+
- code: type_mismatch
9682+
message: contacts must be an array
9683+
contact_not_an_object:
9684+
value:
9685+
type: error.list
9686+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9687+
errors:
9688+
- code: type_mismatch
9689+
message: each contact must be an object
96349690
schema:
96359691
"$ref": "#/components/schemas/error"
96369692
"/contacts/bulk/delete":
@@ -9714,6 +9770,20 @@ paths:
97149770
message: Access Token Invalid
97159771
schema:
97169772
"$ref": "#/components/schemas/error"
9773+
'404':
9774+
description: Not Found
9775+
content:
9776+
application/json:
9777+
examples:
9778+
job_not_found:
9779+
value:
9780+
type: error.list
9781+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9782+
errors:
9783+
- code: job_not_found
9784+
message: job job_v2_1 not found
9785+
schema:
9786+
"$ref": "#/components/schemas/error"
97179787
'422':
97189788
description: Unprocessable Entity
97199789
content:
@@ -9740,6 +9810,20 @@ paths:
97409810
errors:
97419811
- code: parameter_invalid
97429812
message: maximum number of contacts per request is 100
9813+
contacts_not_an_array:
9814+
value:
9815+
type: error.list
9816+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9817+
errors:
9818+
- code: type_mismatch
9819+
message: contacts must be an array
9820+
contact_not_an_object:
9821+
value:
9822+
type: error.list
9823+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9824+
errors:
9825+
- code: type_mismatch
9826+
message: each contact must be an object
97439827
schema:
97449828
"$ref": "#/components/schemas/error"
97459829
"/contacts/bulk/{id}":

0 commit comments

Comments
 (0)