Update the name of a group

​
Usage

import { PinataSDK } from "pinata";

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",
	public: true
});

​
Returns

type GroupResponseItem = {
    id: string;
    is_public: boolean;
    name: string;
    created_at: string;
};

​
Parameters

​
groupId

  • Type: string

ID for the target Group

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

​
name (Optional)

  • Type: string

Updated name for the target group

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

​
isPublic (Optional)

  • Type: boolean

Update a group to be public or private

const groups = await pinata.groups.update({
    isPublic: true
});
removeFilesdelete