Skip to main content

APIError

statusintegerrequired

HTTP status code.

typestringrequired

Machine-readable error type.

Possible values: [invalid_request, validation_error, unsupported_media_type, payload_too_large, method_not_allowed, not_found, authentication_failed, api_key_expired, insufficient_scope, api_key_ip_restricted, domain_scope_restricted, workspace_suspended, test_mode_restricted, domain_not_found, domain_not_verified, invalid_from_address, duplicate_detected, invalid_schedule, email_not_cancellable, batch_too_large, template_not_found, template_render_failed, attachment_not_found, attachment_expired, attachment_too_large, attachment_fetch_failed, rate_limit_exceeded, daily_quota_exceeded, monthly_quota_exceeded, idempotency_conflict, idempotency_in_progress, api_key_in_use, webhook_limit_reached, webhook_url_not_allowed, internal_error, service_unavailable]

messagestringrequired

Human-readable error message.

request_idstringrequired

Unique request identifier for support debugging.

doc_urlstring

Link to documentation for this error type.

details object[]

Additional error details for validation errors.

  • Array [
  • fieldstringrequired

    The field that caused the error.

    messagestringrequired

    Human-readable description of the field error.

    codestringrequired

    Machine-readable error code for this field.

  • ]
  • APIError
    {
    "status": 0,
    "type": "invalid_request",
    "message": "string",
    "request_id": "string",
    "doc_url": "string",
    "details": [
    {
    "field": "string",
    "message": "string",
    "code": "string"
    }
    ]
    }