Skip to content

Commit 4a0d7be

Browse files
VarshSureshclaude
andcommitted
Document 403, 404, and 422 type_mismatch errors on bulk contacts (Preview)
The bulk contacts endpoints raise three error responses that were not documented. Each is reachable through the shared bulk scheduling path 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 4a0d7be

1 file changed

Lines changed: 126 additions & 0 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9466,6 +9466,34 @@ paths:
94669466
message: Access Token Invalid
94679467
schema:
94689468
"$ref": "#/components/schemas/error"
9469+
'403':
9470+
description: Forbidden
9471+
content:
9472+
application/json:
9473+
examples:
9474+
job_closed:
9475+
value:
9476+
type: error.list
9477+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9478+
errors:
9479+
- code: forbidden
9480+
message: job job_v2_1 is closed for new task updates
9481+
schema:
9482+
"$ref": "#/components/schemas/error"
9483+
'404':
9484+
description: Not Found
9485+
content:
9486+
application/json:
9487+
examples:
9488+
job_not_found:
9489+
value:
9490+
type: error.list
9491+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9492+
errors:
9493+
- code: job_not_found
9494+
message: job job_v2_1 not found
9495+
schema:
9496+
"$ref": "#/components/schemas/error"
94699497
'422':
94709498
description: Unprocessable Entity
94719499
content:
@@ -9485,6 +9513,20 @@ paths:
94859513
errors:
94869514
- code: parameter_invalid
94879515
message: maximum number of contacts per request is 100
9516+
contacts_not_an_array:
9517+
value:
9518+
type: error.list
9519+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9520+
errors:
9521+
- code: type_mismatch
9522+
message: contacts must be an array
9523+
contact_not_an_object:
9524+
value:
9525+
type: error.list
9526+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9527+
errors:
9528+
- code: type_mismatch
9529+
message: each contact must be an object
94889530
schema:
94899531
"$ref": "#/components/schemas/error"
94909532
put:
@@ -9605,6 +9647,34 @@ paths:
96059647
message: Access Token Invalid
96069648
schema:
96079649
"$ref": "#/components/schemas/error"
9650+
'403':
9651+
description: Forbidden
9652+
content:
9653+
application/json:
9654+
examples:
9655+
job_closed:
9656+
value:
9657+
type: error.list
9658+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9659+
errors:
9660+
- code: forbidden
9661+
message: job job_v2_1 is closed for new task updates
9662+
schema:
9663+
"$ref": "#/components/schemas/error"
9664+
'404':
9665+
description: Not Found
9666+
content:
9667+
application/json:
9668+
examples:
9669+
job_not_found:
9670+
value:
9671+
type: error.list
9672+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9673+
errors:
9674+
- code: job_not_found
9675+
message: job job_v2_1 not found
9676+
schema:
9677+
"$ref": "#/components/schemas/error"
96089678
'422':
96099679
description: Unprocessable Entity
96109680
content:
@@ -9631,6 +9701,20 @@ paths:
96319701
errors:
96329702
- code: parameter_invalid
96339703
message: maximum number of contacts per request is 100
9704+
contacts_not_an_array:
9705+
value:
9706+
type: error.list
9707+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9708+
errors:
9709+
- code: type_mismatch
9710+
message: contacts must be an array
9711+
contact_not_an_object:
9712+
value:
9713+
type: error.list
9714+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9715+
errors:
9716+
- code: type_mismatch
9717+
message: each contact must be an object
96349718
schema:
96359719
"$ref": "#/components/schemas/error"
96369720
"/contacts/bulk/delete":
@@ -9714,6 +9798,34 @@ paths:
97149798
message: Access Token Invalid
97159799
schema:
97169800
"$ref": "#/components/schemas/error"
9801+
'403':
9802+
description: Forbidden
9803+
content:
9804+
application/json:
9805+
examples:
9806+
job_closed:
9807+
value:
9808+
type: error.list
9809+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9810+
errors:
9811+
- code: forbidden
9812+
message: job job_v2_1 is closed for new task updates
9813+
schema:
9814+
"$ref": "#/components/schemas/error"
9815+
'404':
9816+
description: Not Found
9817+
content:
9818+
application/json:
9819+
examples:
9820+
job_not_found:
9821+
value:
9822+
type: error.list
9823+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9824+
errors:
9825+
- code: job_not_found
9826+
message: job job_v2_1 not found
9827+
schema:
9828+
"$ref": "#/components/schemas/error"
97179829
'422':
97189830
description: Unprocessable Entity
97199831
content:
@@ -9740,6 +9852,20 @@ paths:
97409852
errors:
97419853
- code: parameter_invalid
97429854
message: maximum number of contacts per request is 100
9855+
contacts_not_an_array:
9856+
value:
9857+
type: error.list
9858+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9859+
errors:
9860+
- code: type_mismatch
9861+
message: contacts must be an array
9862+
contact_not_an_object:
9863+
value:
9864+
type: error.list
9865+
request_id: 2859da57-c83f-405c-8166-240a312442a3
9866+
errors:
9867+
- code: type_mismatch
9868+
message: each contact must be an object
97439869
schema:
97449870
"$ref": "#/components/schemas/error"
97459871
"/contacts/bulk/{id}":

0 commit comments

Comments
 (0)