ComPDF AI Open API Error Code Reference

Scope

This reference applies only to public Open API requests.

Error Response

Open API error responses contain an HTTP status, a numeric code, a stable error_code, a message, and optional data:

{
  "code": 102,
  "error_code": "INVALID_RULE_CONFIGURATION",
  "message": "Invalid reminder rule configuration",
  "data": false
}

Use error_code to identify the error. Do not parse the human-readable message.

Open API Error Codes

error_code	Code	HTTP status	Description
INTERNAL_ERROR	100	500	An unexpected server-side failure occurred.
INVALID_ARGUMENT	101	400	A request parameter is missing, invalid, or has an unsupported format.
INVALID_RULE_STATUS	102	400	The supplied reminder-rule status is not allowed.
INVALID_RULE_CONFIGURATION	102	400	The reminder-rule conditions, frequency, delivery channels, or recipients are invalid.
API_KEY_REQUIRED	401	401	The request does not include a Service API Key.
API_KEY_INVALID	401	401	The Service API Key is invalid, inactive, or expired.
RULE_NOT_FOUND	404	404	The requested reminder rule does not exist or is not available to the API Key organization.
RESOURCE_CONFLICT	409	409	The resource cannot be changed in its current state.

Reminder Rule API Mapping

Open API	Possible error_code values
POST /api/v2/rules	API_KEY_REQUIRED, API_KEY_INVALID, INVALID_RULE_CONFIGURATION, RESOURCE_CONFLICT, INTERNAL_ERROR
GET /api/v2/rules	API_KEY_REQUIRED, API_KEY_INVALID, INVALID_ARGUMENT, INVALID_RULE_STATUS, INTERNAL_ERROR
GET /api/v2/rules/{ruleId}	API_KEY_REQUIRED, API_KEY_INVALID, RULE_NOT_FOUND, INTERNAL_ERROR
PUT /api/v2/rules/{ruleId}	API_KEY_REQUIRED, API_KEY_INVALID, INVALID_RULE_CONFIGURATION, RULE_NOT_FOUND, RESOURCE_CONFLICT, INTERNAL_ERROR
PATCH /api/v2/rules/{ruleId}/status	API_KEY_REQUIRED, API_KEY_INVALID, INVALID_RULE_STATUS, RULE_NOT_FOUND, INTERNAL_ERROR
DELETE /api/v2/rules/{ruleId}	API_KEY_REQUIRED, API_KEY_INVALID, RULE_NOT_FOUND, INTERNAL_ERROR