Procedure · POST

group.opensocial.putRule

Create or update a rule.

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

Requires: group.configure

Input

groupstring · didrequired

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

rkeystring · record-key

titlestringrequired

≤ 100 graphemes

textstring

≤ 2000 graphemes

Output

uristring · at-urirequired

cidstring · cidrequired

Schema

Lexicon JSON

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

← All methods