Skip to content

Commit cd7c0bb

Browse files
VarshSureshclaude
andauthored
Document 403, 404, and 422 type_mismatch errors on bulk contacts (Preview) (#610)
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 bf28255 commit cd7c0bb

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
@@ -9990,6 +9990,34 @@ paths:
99909990
message: Access Token Invalid
99919991
schema:
99929992
"$ref": "#/components/schemas/error"
9993+
'403':
9994+
description: Forbidden
9995+
content:
9996+
application/json:
9997+
examples:
9998+
job_closed:
9999+
value:
10000+
type: error.list
10001+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10002+
errors:
10003+
- code: forbidden
10004+
message: job job_v2_1 is closed for new task updates
10005+
schema:
10006+
"$ref": "#/components/schemas/error"
10007+
'404':
10008+
description: Not Found
10009+
content:
10010+
application/json:
10011+
examples:
10012+
job_not_found:
10013+
value:
10014+
type: error.list
10015+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10016+
errors:
10017+
- code: job_not_found
10018+
message: job job_v2_1 not found
10019+
schema:
10020+
"$ref": "#/components/schemas/error"
999310021
'422':
999410022
description: Unprocessable Entity
999510023
content:
@@ -10009,6 +10037,20 @@ paths:
1000910037
errors:
1001010038
- code: parameter_invalid
1001110039
message: maximum number of contacts per request is 100
10040+
contacts_not_an_array:
10041+
value:
10042+
type: error.list
10043+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10044+
errors:
10045+
- code: type_mismatch
10046+
message: contacts must be an array
10047+
contact_not_an_object:
10048+
value:
10049+
type: error.list
10050+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10051+
errors:
10052+
- code: type_mismatch
10053+
message: each contact must be an object
1001210054
schema:
1001310055
"$ref": "#/components/schemas/error"
1001410056
put:
@@ -10129,6 +10171,34 @@ paths:
1012910171
message: Access Token Invalid
1013010172
schema:
1013110173
"$ref": "#/components/schemas/error"
10174+
'403':
10175+
description: Forbidden
10176+
content:
10177+
application/json:
10178+
examples:
10179+
job_closed:
10180+
value:
10181+
type: error.list
10182+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10183+
errors:
10184+
- code: forbidden
10185+
message: job job_v2_1 is closed for new task updates
10186+
schema:
10187+
"$ref": "#/components/schemas/error"
10188+
'404':
10189+
description: Not Found
10190+
content:
10191+
application/json:
10192+
examples:
10193+
job_not_found:
10194+
value:
10195+
type: error.list
10196+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10197+
errors:
10198+
- code: job_not_found
10199+
message: job job_v2_1 not found
10200+
schema:
10201+
"$ref": "#/components/schemas/error"
1013210202
'422':
1013310203
description: Unprocessable Entity
1013410204
content:
@@ -10155,6 +10225,20 @@ paths:
1015510225
errors:
1015610226
- code: parameter_invalid
1015710227
message: maximum number of contacts per request is 100
10228+
contacts_not_an_array:
10229+
value:
10230+
type: error.list
10231+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10232+
errors:
10233+
- code: type_mismatch
10234+
message: contacts must be an array
10235+
contact_not_an_object:
10236+
value:
10237+
type: error.list
10238+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10239+
errors:
10240+
- code: type_mismatch
10241+
message: each contact must be an object
1015810242
schema:
1015910243
"$ref": "#/components/schemas/error"
1016010244
"/contacts/bulk/delete":
@@ -10238,6 +10322,34 @@ paths:
1023810322
message: Access Token Invalid
1023910323
schema:
1024010324
"$ref": "#/components/schemas/error"
10325+
'403':
10326+
description: Forbidden
10327+
content:
10328+
application/json:
10329+
examples:
10330+
job_closed:
10331+
value:
10332+
type: error.list
10333+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10334+
errors:
10335+
- code: forbidden
10336+
message: job job_v2_1 is closed for new task updates
10337+
schema:
10338+
"$ref": "#/components/schemas/error"
10339+
'404':
10340+
description: Not Found
10341+
content:
10342+
application/json:
10343+
examples:
10344+
job_not_found:
10345+
value:
10346+
type: error.list
10347+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10348+
errors:
10349+
- code: job_not_found
10350+
message: job job_v2_1 not found
10351+
schema:
10352+
"$ref": "#/components/schemas/error"
1024110353
'422':
1024210354
description: Unprocessable Entity
1024310355
content:
@@ -10264,6 +10376,20 @@ paths:
1026410376
errors:
1026510377
- code: parameter_invalid
1026610378
message: maximum number of contacts per request is 100
10379+
contacts_not_an_array:
10380+
value:
10381+
type: error.list
10382+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10383+
errors:
10384+
- code: type_mismatch
10385+
message: contacts must be an array
10386+
contact_not_an_object:
10387+
value:
10388+
type: error.list
10389+
request_id: 2859da57-c83f-405c-8166-240a312442a3
10390+
errors:
10391+
- code: type_mismatch
10392+
message: each contact must be an object
1026710393
schema:
1026810394
"$ref": "#/components/schemas/error"
1026910395
"/contacts/bulk/{id}":

0 commit comments

Comments
 (0)