RanklyBee logoRanklyBee

Error handling

Handle stable error codes and validation failures.

Every failure uses the same envelope. Branch on error.code, which is stable; error.message is intended for humans and may change.

{
  "ok": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested workspace was not found."
  }
}

Common errors

CodeHTTP statusWhat to do
UNAUTHORIZED401Check that the token is present, valid, and not revoked.
SCOPE_REQUIRED403Add the required scope or use a token with the correct access.
NOT_FOUND404Check the workspace, site, or backlink filters.
VALIDATION_ERROR422Correct the request parameter or body.
SETUP_REQUIRED422Configure the required RanklyBee resource before retrying.
OPERATION_FAILED422The requested write operation could not be completed.
RATE_LIMIT_EXCEEDED429Wait for Retry-After before retrying.

On this page