chat.bsky.group.addMembers

Adds members to a group. The members are added in 'request' status, so they have to accept it. This creates convo memberships.

Details · procedure
Kindprocedure
Authoritygroup.bsky.chat
Indexed
cid bafyreiftelalu5yc3zctgch7req6syovskusqgma5vyyd4elas5rs47tvy

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.convoIdNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Adds members to a group. The members are added in 'request' status, so they have to accept it. This creates convo memberships.",
      "errors": [
        {
          "name": "AccountSuspended"
        },
        {
          "name": "BlockedActor"
        },
        {
          "name": "BlockedSubject"
        },
        {
          "name": "ConvoLocked"
        },
        {
          "name": "InsufficientRole"
        },
        {
          "name": "InvalidConvo"
        },
        {
          "name": "MemberLimitReached"
        },
        {
          "name": "NotFollowedBySender"
        },
        {
          "name": "RecipientNotFound"
        },
        {
          "name": "UserForbidsGroups"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "convoId": {
              "type": "string"
            },
            "members": {
              "items": {
                "format": "did",
                "type": "string"
              },
              "minLength": 1,
              "type": "array"
            }
          },
          "required": [
            "convoId",
            "members"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "addedMembers": {
              "items": {
                "ref": "chat.bsky.actor.defs#profileViewBasic",
                "type": "ref"
              },
              "type": "array"
            },
            "convo": {
              "ref": "chat.bsky.convo.defs#convoView",
              "type": "ref"
            }
          },
          "required": [
            "convo"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "chat.bsky.group.addMembers",
  "lexicon": 1
}