Errors
{
"errors": [
{
"id": "21bd9ca2-8442-41a1-8845-6d8ba266e282",
"title": "short description of the problem",
"code": "E11",
"detail": "human-readable explanation specific to this occurrence of the problem",
"meta": {
"key": "extra data value if applicable"
}
}
]
}
Any response can contain errors. The errors
property is an array of error objects, so there can be multiple errors returned. Each object has the following:
code
is an application-specific error code. This can be used by consumers to decide how to deal with certain types of errors, etc. The possible codes are listed below.id
is a reference for this exact instance of the error, which can help with debugging. If you’re contacting us at api@teamork.com with a problem, please give it.title
is a short, human-readable summary of the problem.detail
is a human-readable explanation specific to this occurrence of the problem.
Codes
The following are the error codes used in the API responses for different scenarios. This code can be matched against programmatically to handle different scenarios, do not rely on the detail
as this could be changed or translated in the future while the codes will remain the same.
General request errors
E1
- Unauthorized, invalid or no authentication givenE2
- Logged in but lack the permission to perform an actionE3
- Not foundE4
- Bad requestE5
- Internal server errorE6
- CRM not enabled on installationE7
- CRM enabled, but not setup on installationE8
- User doesn’t have access to CRME9
- Subscription endedE10
- Trial expiredE11
- Subscription payment failedE12
- Payment required
Validation errors
V1
- Attribute validation errorsV2
- Relationship validation errors
Unsupported operations
U1
- Pipeline stages addU2
- Pipeline stages updateU3
- Stage deals updateU4
- Unsupported file target type
Duplication errors
D1
- Generic duplicate key constraintD2
- Duplicated assignee entryD3
- Duplicated contacts entryD4
- Duplicated email addressD5
- Duplicated phone numberD6
- Duplicated productD7
- Duplicated product priceD8
- Duplicated custom filter nameD9
- Duplicated product nameD10
- Duplicated pipeline nameD11
- Duplicated contact main email addressD12
- Duplicated company nameD13
- Duplicated foreign itemD14
- Duplicated activity type nameD15
- Duplicated activity type colorD16
- Duplicated activity type iconD17
- Duplicated custom field name with kind
Conflict errors
C1
- Contact has been listed as a main contact for another dealsC2
- Ativity type limit reachedC4
- Unknown custom field used in custom filterC5
- User with email already exitsC6
- User with email already exits deprecatedC7
- User not invitedC8
- The entity or entities trying to be created already exists.
Unknown errors
?1_$column
- Unknown column,$column
will be replaced with the column that was unknown?2
- Unknown custom field?3
- Unknown tempId on file upload?4
- Unknown custom filterId
Limit errors
L1
- Custom field limit reachedL2
- There is already a maximum of 3 exports running
Billing errors
B1
- Billing error occurred during request, check detail for explanation
Feedback
If you have any feedback or suggestions, feel free to contact us at api@teamwork.com.