chat.bsky.group.addMembers

bsky-lexicons.bsky.social

Documentation

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

main procedure

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

Input

Encodingapplication/json
convoId string Required

No description available.

members array Required

No description available.

minLength: 1 items

Output

Encodingapplication/json
addedMembers array Optional

No description available.

Errors

AccountSuspended
BlockedActor
BlockedSubject
ConvoLocked
InsufficientRole
InvalidConvo
MemberLimitReached
NotFollowedBySender
RecipientNotFound
UserForbidsGroups
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": [
        "convoId",
        "members"
      ],
      "properties": {
        "convoId": {
          "type": "string"
        },
        "members": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "did"
          },
          "minLength": 1
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AccountSuspended"
    },
    {
      "name": "BlockedActor"
    },
    {
      "name": "BlockedSubject"
    },
    {
      "name": "ConvoLocked"
    },
    {
      "name": "InsufficientRole"
    },
    {
      "name": "InvalidConvo"
    },
    {
      "name": "MemberLimitReached"
    },
    {
      "name": "NotFollowedBySender"
    },
    {
      "name": "RecipientNotFound"
    },
    {
      "name": "UserForbidsGroups"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "convo"
      ],
      "properties": {
        "convo": {
          "ref": "chat.bsky.convo.defs#convoView",
          "type": "ref"
        },
        "addedMembers": {
          "type": "array",
          "items": {
            "ref": "chat.bsky.actor.defs#profileViewBasic",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Adds members to a group. The members are added in 'request' status, so they have to accept it. This creates convo memberships."
}

Lexicon Garden

@