fyi.opensocial.putRule

lexicons.opensocial.fyi

Documentation

Create or update a rule. Requires group.configure. Fields are inlined rather than referencing fyi.opensocial.rule, because a record def cannot be used as an input object — same fix as updateProfile.

main procedure

Create or update a rule. Requires group.configure. Fields are inlined rather than referencing fyi.opensocial.rule, because a record def cannot be used as an input object — same fix as updateProfile.

Input

Encodingapplication/json
group stringdid Required

The group DID. Every method is served by the group's host and authorized against that group's roles.

rkey stringrecord-key Optional

A valid record key for AT Protocol repositories.

text string Optional

No description available.

maxLength: 20000 bytesmaxGraphemes: 2000 graphemes
title string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

Output

Encodingapplication/json
cid stringcid Required

A content identifier (CID) referencing immutable data.

uri stringat-uri Required

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

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": "Create or update a rule. Requires group.configure. Fields are inlined rather than referencing fyi.opensocial.rule, because a record def cannot be used as an input object — same fix as updateProfile.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "group": {
          "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
          "format": "did",
          "type": "string"
        },
        "rkey": {
          "format": "record-key",
          "type": "string"
        },
        "text": {
          "maxGraphemes": 2000,
          "maxLength": 20000,
          "type": "string"
        },
        "title": {
          "maxGraphemes": 100,
          "maxLength": 1000,
          "type": "string"
        }
      },
      "required": [
        "group",
        "title"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "format": "cid",
          "type": "string"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@