chat.bsky.group.createGroup

bsky-lexicons.bsky.social

Documentation

Creates a group convo, specifying the members to be added to it. Unlike getConvoForMembers, this isn't idempotent. It will create new groups even if the membership is identical to pre-existing groups. Will create 'request' membership for all members, except the owner who is 'accepted'.

main procedure

Creates a group convo, specifying the members to be added to it. Unlike getConvoForMembers, this isn't idempotent. It will create new groups even if the membership is identical to pre-existing groups. Will create 'request' membership for all members, except the owner who is 'accepted'.

Input

Encodingapplication/json
members array Required

No description available.

maxLength: 49 items
name string Required

No description available.

maxLength: 500 bytesminLength: 1 bytesmaxGraphemes: 50 graphemes

Output

Encodingapplication/json

Errors

AccountSuspended
BlockedActor
BlockedSubject
NewAccountCannotCreateGroup
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": [
        "members",
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 500,
          "minLength": 1,
          "maxGraphemes": 50
        },
        "members": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "did"
          },
          "maxLength": 49
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AccountSuspended"
    },
    {
      "name": "BlockedActor"
    },
    {
      "name": "BlockedSubject"
    },
    {
      "name": "NewAccountCannotCreateGroup"
    },
    {
      "name": "NotFollowedBySender"
    },
    {
      "name": "RecipientNotFound"
    },
    {
      "name": "UserForbidsGroups"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "convo"
      ],
      "properties": {
        "convo": {
          "ref": "chat.bsky.convo.defs#convoView",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Creates a group convo, specifying the members to be added to it. Unlike getConvoForMembers, this isn't idempotent. It will create new groups even if the membership is identical to pre-existing groups. Will create 'request' membership for all members, except the owner who is 'accepted'."
}

Lexicon Garden

@