Skip to content

Remove the documented 500 responses from the contacts spec #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Rabsztok merged 3 commits into from
Nov 6, 2026
Merged

Remove the documented 500 responses from the contacts spec #65

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
203fbb1
Remove the documented 500 responses from the contacts spec
Rabsztok Nov 4, 2026
c70ecf2
Use a real error as the contacts ErrorResponse example
Rabsztok Nov 5, 2026
ebfe331
Drop the examples from the contacts ErrorResponse schema
Rabsztok Nov 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 0 additions & 51 deletions specs/contacts.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,6 @@ paths:
errors: Invalid token
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
post:
operationId: createContact
summary: Create a new Contact
Expand Down Expand Up @@ -449,8 +447,6 @@ paths:
- Email is invalid
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
'/api/contacts/{contact_identifier}':
get:
description: Get contact using UUID or email (URL encoded)
Expand Down Expand Up @@ -634,8 +630,6 @@ paths:
$ref: '#/components/responses/NOT_FOUND'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
patch:
description: Update contact using UUID or email (URL encoded)
operationId: updateContact
Expand Down Expand Up @@ -799,8 +793,6 @@ paths:
- - contains invalid data
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
delete:
description: Delete contact using UUID or email (URL encoded)
operationId: deleteContact
Expand Down Expand Up @@ -912,8 +904,6 @@ paths:
errors: Contact(s) not found
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
parameters:
- $ref: '#/components/parameters/contact_identifier'
'/api/contacts/{contact_identifier}/events':
Expand Down Expand Up @@ -1082,8 +1072,6 @@ paths:
- value for 'bar' is too long
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
parameters:
- $ref: '#/components/parameters/contact_identifier'
'/api/contacts/exports':
Expand Down Expand Up @@ -1252,8 +1240,6 @@ paths:
- There is a previous export initiated. You will be notified by email once it is completed.
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
'/api/contacts/exports/{export_id}':
get:
description: Get Contact Export
Expand Down Expand Up @@ -1391,8 +1377,6 @@ paths:
$ref: '#/components/responses/NOT_FOUND'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
parameters:
- $ref: '#/components/parameters/export_id'
'/api/contacts/imports':
Expand Down Expand Up @@ -1575,8 +1559,6 @@ paths:
- 'contains invalid values: invalid_field'
field_merge_tag:
- is invalid
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
'/api/contacts/imports/{import_id}':
get:
description: Get Contact Import
Expand Down Expand Up @@ -1700,8 +1682,6 @@ paths:
$ref: '#/components/responses/PERMISSION_DENIED'
'404':
$ref: '#/components/responses/NOT_FOUND'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
parameters:
- $ref: '#/components/parameters/import_id'
'/api/contacts/lists':
Expand Down Expand Up @@ -1838,8 +1818,6 @@ paths:
$ref: '#/components/responses/PERMISSION_DENIED'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
post:
description: Create new Contact Lists
operationId: createContactList
Expand Down Expand Up @@ -1984,8 +1962,6 @@ paths:
$ref: '#/components/responses/PERMISSION_DENIED'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
'/api/contacts/lists/{list_id}':
get:
description: Get a contact list by ID
Expand Down Expand Up @@ -2097,8 +2073,6 @@ paths:
$ref: '#/components/responses/NOT_FOUND'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
patch:
description: Update existing Contact List
operationId: updateContactList
Expand Down Expand Up @@ -2228,8 +2202,6 @@ paths:
$ref: '#/components/responses/NOT_FOUND'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
delete:
description: Delete existing Contact List
operationId: deleteContactList
Expand Down Expand Up @@ -2333,8 +2305,6 @@ paths:
$ref: '#/components/responses/NOT_FOUND'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
parameters:
- $ref: '#/components/parameters/list_id'
'/api/contacts/fields':
Expand Down Expand Up @@ -2461,8 +2431,6 @@ paths:
$ref: '#/components/responses/PERMISSION_DENIED'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
post:
description: |
Create new Contact Fields. Please note, you can have up to 40 fields.
Expand Down Expand Up @@ -2648,8 +2616,6 @@ paths:
- has already been taken
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
'/api/contacts/fields/{field_id}':
get:
description: Get a contact Field by ID
Expand Down Expand Up @@ -2764,8 +2730,6 @@ paths:
$ref: '#/components/responses/NOT_FOUND'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
patch:
description: |
Update existing Contact Field. Please note, you cannot change data_type of the field.
Expand Down Expand Up @@ -2921,8 +2885,6 @@ paths:
- has already been taken
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
delete:
description: |
Delete existing Contact Field Please, note, you cannot delete a Contact Field which is used in Automations, Email Campaigns (started or scheduled), and in conditions of Contact Segments (you'll see the corresponding error)
Expand Down Expand Up @@ -3038,8 +3000,6 @@ paths:
- 'This field is used in the conditions of segment(s): {segment names}.'
'429':
$ref: '#/components/responses/LIMIT_EXCEEDED'
'500':
$ref: '#/components/responses/INTERNAL_ERROR'
parameters:
- $ref: '#/components/parameters/field_id'
components:
Expand Down Expand Up @@ -3576,9 +3536,6 @@ components:
errors:
type: string
description: Error message
example: Unexpected error
example:
errors: Unexpected error
NotFoundResponse:
title: NotFoundResponse
type: object
Expand Down Expand Up @@ -3659,14 +3616,6 @@ components:
$ref: '#/components/schemas/PermissionsDeniedResponse'
example:
errors: Account access forbidden
INTERNAL_ERROR:
description: Internal error. Retry later or contact support.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
errors: Unexpected error
NOT_FOUND:
description: Resource not found
content:
Expand Down
Loading