MenuMethods

Procedure · POST

group.opensocial.applyLabel

Write a label into the subject's space.

Write a label record into the subject's space. Requires label, or takedown for !hide and !takedown.

Requires
label / takedown

Input

groupstring · didrequired

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

subjectunion of com.atproto.admin.defs#repoRef | com.atproto.repo.strongRefrequired
valstringrequired
rulestring · at-uri

Output

uristring · at-urirequired
cidstring · cidrequired

Schema

Lexicon JSON
{
  "lexicon": 1,
  "id": "group.opensocial.applyLabel",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Write a label record into the subject's space. Requires label, or takedown for !hide and !takedown.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "group",
            "subject",
            "val"
          ],
          "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."
            },
            "subject": {
              "type": "union",
              "refs": [
                "com.atproto.admin.defs#repoRef",
                "com.atproto.repo.strongRef"
              ]
            },
            "val": {
              "type": "string"
            },
            "rule": {
              "type": "string",
              "format": "at-uri"
            }
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "uri",
            "cid"
          ],
          "properties": {
            "uri": {
              "type": "string",
              "format": "at-uri"
            },
            "cid": {
              "type": "string",
              "format": "cid"
            }
          }
        }
      }
    }
  }
}

← All methods