Update the name of a group

Usage

import { PinataSDK } from "pinata-web3";

const pinata = new PinataSDK({
  pinataJwt: process.env.PINATA_JWT!,
  pinataGateway: "example-gateway.mypinata.cloud",
});

const groups = await pinata.groups.update({
	groupId: "3778c10d-452e-4def-8299-ee6bc548bdb0",
	name: "My New Group 2"
});

Returns

type GroupResponseItem = {
  id: string;
  user_id: string;
  name: string;
  updatedAt: string;
  createdAt: string;
};

Parameters

groupId

  • Type: string

ID for the target Group

const groups = await pinata.groups.update({
	groupId: "3778c10d-452e-4def-8299-ee6bc548bdb0",
});

name

  • Type: string

Updated name for the target group

const groups = await pinata.groups.update({
	name: "My Group Again",
});