social.colibri.beta.community.negateLabel

colibri.social

Documentation

Retracts a label by writing a negating one. The original label record is left in place.

main procedure

Retracts a label by writing a negating one. The original label record is left in place.

Input

Encodingapplication/json
reason string Optional

Human-readable reason for the retraction.

maxLength: 512 bytes
space stringspace-ref Required

The space the labelled record lives in.

val string Required

The label value to retract.

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
Forbidden The caller lacks the label.apply permission.
CommunityNotFound No community exists at the given DID.
SpaceNotFound No space exists at the given reference.
LabelNotFound No active label matching the subject and value exists to negate.
CredentialsUnavailable The AppView cannot act as the community because its stored credentials are missing or unusable.
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 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "space",
        "subject",
        "val"
      ],
      "properties": {
        "val": {
          "type": "string",
          "description": "The label value to retract."
        },
        "space": {
          "type": "string",
          "format": "space-ref",
          "description": "The space the labelled record lives in."
        },
        "reason": {
          "type": "string",
          "maxLength": 512,
          "description": "Human-readable reason for the retraction."
        },
        "subject": {
          "ref": "social.colibri.beta.label#subject",
          "type": "ref",
          "description": "The labelled record."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the label.apply permission."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists at the given DID."
    },
    {
      "name": "SpaceNotFound",
      "description": "No space exists at the given reference."
    },
    {
      "name": "LabelNotFound",
      "description": "No active label matching the subject and value exists to negate."
    },
    {
      "name": "CredentialsUnavailable",
      "description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "properties": {}
    },
    "encoding": "application/json"
  },
  "description": "Retracts a label by writing a negating one. The original label record is left in place."
}

Lexicon Garden

@