pub.chive.activity.markFailed Documentation (EN)

main procedure

Mark a pending activity as failed when PDS write fails

Input

Encodingapplication/json

collection string Required

NSID of the record collection

errorCode string Required

Error code identifying the failure type

maxLength: 50 bytes

errorMessage string Required

Human-readable error message

maxLength: 1000 bytes

rkey string Required

Record key (TID)

Output

Encodingapplication/json

success boolean Required

Whether the activity was successfully marked as failed

Errors

AuthenticationRequired

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": [
        "collection",
        "rkey",
        "errorCode",
        "errorMessage"
      ],
      "properties": {
        "rkey": {
          "type": "string",
          "description": "Record key (TID)"
        },
        "errorCode": {
          "type": "string",
          "maxLength": 50,
          "description": "Error code identifying the failure type"
        },
        "collection": {
          "type": "string",
          "description": "NSID of the record collection"
        },
        "errorMessage": {
          "type": "string",
          "maxLength": 1000,
          "description": "Human-readable error message"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "success"
      ],
      "properties": {
        "success": {
          "type": "boolean",
          "description": "Whether the activity was successfully marked as failed"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Mark a pending activity as failed when PDS write fails"
}