Create a Group

This guide will help you create a Group on Lens.

To create an Group, follow these steps.

You MUST be authenticated as Builder, Account Manager, or Account Owner to create a Group.

Create Group Metadata

First, construct a Group Metadata object.

TS/JS
JSON Schema

Use the @lens-protocol/metadata package to construct a valid GroupMetadata object:

Exampleimport { group } from "@lens-protocol/metadata";
const metadata = group({  name: "XYZ",  description: "My group description",  icon: "lens://BsdfA…",});

Upload Group Metadata

Next, upload the Group Metadata object to a public URI.

import { storageClient } from "./storage-client";
const { uri } = await storageClient.uploadAsJson(metadata);
console.log(uri); // e.g., lens://4f91ca…

This example uses Lens Storage to host the Metadata object. See the Lens Metadata Standards guide for more information on hosting Metadata objects.

Deploy Group Contract

Next, deploy the Group smart contract.

TypeScript
GraphQL
React

Use the createGroup action to deploy the Lens Group smart contract.

import { uri } from "@lens-protocol/client";import { createGroup } from "@lens-protocol/client/actions";
const result = await createGroup(sessionClient, {  metadataUri: uri("lens://4f91c…"),});

To learn more about how to use Group Rules, see the Group Rules guide.

Handle Result

TypeScript
GraphQL
React

Finally, handle the result using the adapter for the library of your choice:

import { handleOperationWith } from "@lens-protocol/client/viem";
// …
const result = await createGroup(sessionClient, {  metadataUri: uri("lens://4f91ca…"),}).andThen(handleOperationWith(walletClient));

See the Transaction Lifecycle guide for more information on how to determine the status of the transaction.

That's it—you have successfully created a Group on Lens!