com.getorbyt.community.createReport

getorbyt.com

Documentation

Creates a private Community-moderator report for a linked post. Requires authenticated service authorization.

main procedure

Creates a private Community-moderator report for a linked post. Requires authenticated service authorization.

Input

Encodingapplication/json
community stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

details string Optional

Anything the reporter wants moderators to know.

maxLength: 2000 bytes
post stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

reason string Required

Human-readable reason, shown by builds that do not read reasonType.

maxLength: 2000 bytesminLength: 1 bytes
reasonType string Optional

No description available.

ruleIndex integer Optional

With reasonType rule: the position of the broken rule in the Community's rules.

minimum: 0

Output

Encodingapplication/json
created boolean Required

No description available.

Errors

AuthenticationRequired
CommunityNotFound
PostNotFound
RateLimitExceeded
InvalidRequest
RuleNotFound
Try It

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

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Creates a private Community-moderator report for a linked post. Requires authenticated service authorization.",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "CommunityNotFound"
    },
    {
      "name": "PostNotFound"
    },
    {
      "name": "RateLimitExceeded"
    },
    {
      "name": "InvalidRequest"
    },
    {
      "name": "RuleNotFound"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "community": {
          "format": "at-uri",
          "type": "string"
        },
        "details": {
          "description": "Anything the reporter wants moderators to know.",
          "maxLength": 2000,
          "type": "string"
        },
        "post": {
          "format": "at-uri",
          "type": "string"
        },
        "reason": {
          "description": "Human-readable reason, shown by builds that do not read reasonType.",
          "maxLength": 2000,
          "minLength": 1,
          "type": "string"
        },
        "reasonType": {
          "knownValues": [
            "rule",
            "spam",
            "harassment",
            "unsafe",
            "other"
          ],
          "type": "string"
        },
        "ruleIndex": {
          "description": "With reasonType rule: the position of the broken rule in the Community's rules.",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "community",
        "post",
        "reason"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "created": {
          "type": "boolean"
        },
        "report": {
          "ref": "com.getorbyt.community.defs#reportView",
          "type": "ref"
        }
      },
      "required": [
        "report",
        "created"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@