update

org:groups:write

Update the name of a public 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.public.update({
	groupId: "3778c10d-452e-4def-8299-ee6bc548bdb0",
	name: "My New Group 2",
});

Returns

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

Parameters

groupId

• Type: string

ID for the target Group

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

name (Optional)

• Type: string

Updated name for the target group

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