Canonical error envelope. error is the human-readable message; type, code, param, platform, and platformError are top-level siblings for programmatic handling. For upstream platform failures (type: platform_error), platformError carries the provider's raw payload verbatim (for Meta: error_subcode, error_user_title, error_user_msg).
| Name |
Type |
Description |
Notes |
| error |
String |
Human-readable error message. |
[optional] |
| type |
TypeEnum |
Error class for programmatic handling. |
[optional] |
| code |
String |
Stable machine-readable error code. |
[optional] |
| param |
String |
The request field that caused the error, when applicable. |
[optional] |
| platform |
String |
Upstream platform (e.g. meta, google, tiktok) — present when type is platform_error. |
[optional] |
| platformError |
Map<String, Object> |
Raw error payload from the upstream platform, passed through verbatim so integrators can read provider-specific codes. For Meta this includes error_subcode, error_user_title, and error_user_msg. |
[optional] |
| details |
Map<String, Object> |
Additional structured context (e.g. field-level validation errors). |
[optional] |
| Name |
Value |
| INVALID_REQUEST_ERROR |
"invalid_request_error" |
| AUTHENTICATION_ERROR |
"authentication_error" |
| PERMISSION_ERROR |
"permission_error" |
| NOT_FOUND |
"not_found" |
| RATE_LIMIT_ERROR |
"rate_limit_error" |
| PLATFORM_ERROR |
"platform_error" |
| API_ERROR |
"api_error" |