pub.chive.claiming.rejectClaim Documentation (EN)

main procedure

Reject a pending claim with a reason. Admin only.

Input

Encodingapplication/json

claimId integer Required

ID of the claim request to reject

reason string Required

Rejection reason

maxLength: 500 bytesminLength: 1 bytes

Output

Encodingapplication/json

success boolean Required

Whether the rejection was successful

Errors

AuthenticationRequired

Forbidden

NotFound

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "claimId",
        "reason"
      ],
      "properties": {
        "reason": {
          "type": "string",
          "maxLength": 500,
          "minLength": 1,
          "description": "Rejection reason"
        },
        "claimId": {
          "type": "integer",
          "description": "ID of the claim request to reject"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "Forbidden"
    },
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "success"
      ],
      "properties": {
        "success": {
          "type": "boolean",
          "description": "Whether the rejection was successful"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Reject a pending claim with a reason. Admin only."
}