Error Handling
For non-200 expected error responses, DottedSign API provides error information through the JSON response body.
Error Format
{
"error_code": 400417,
"error_key": "invalid_params",
"error_message": "invalid params"
}
Parameter | Description |
---|---|
error_code | A specific error code from DottedSign API. The first three digits represent the corresponding status code, while the last three digits are a unique identifier for the specific error. |
error_key | A key identifier for the error, serving as a concise reference to the type of error encountered. |
error_message | A detailed message about the error, usually summarizing the cause or nature of the error. |
Common Error Code
Error Key | Error Code | Description |
---|---|---|
400_002 | invalid_token | The token is invalid. Please ensure using the correct token in the request header. |
400_003 | invalid_member | The token is invalid. Please ensure using the correct token in the request header. |
400_005 | invalid_client | The client is invalid. Please register a valid Open API application and use the correct DottedSign API endpoints. |
400_008 | invalid_scope | The scope is invalid, typically during token exchange. Please refer to API Scope for proper scope definition. |
400_033 | task_deleted | The task has been deleted. |
400_417 | invalid_params | The parameters are invalid, typically due to incorrect parameter values or format errors. |
403_002 | invalid_action | The action is invalid to perform, typically related to incorrect application or token scope. Please refer to API Scope for more details. |
403_032 | over_monthly_task_usage | The user exceeds task monthly creation limit. See DottedSign Pricing Plan for more details. |
403_036 | task_not_accessible | The task is inaccessible by the current user, typically due to incorrect task participants, or incorrect permission configured by task owner by the group admin. |
403_044 | template_not_accessible | The template is inaccessible by the current user, typically due to incorrect template owner, or incorrect permission configured by template owner or group admin. |
404_431 | task_not_found | Task not found, possibly from incorrect task_id . |
404_035 | template_not_found | Template not found, possibly from incorrect template_id . |
For 500
internal server error, please refer to DottedSign customer support.
Updated 8 months ago