SDK Reference
Methods
Deprecated
UpdateGroup

updateGroup

⚠️

Groups have been deprecated in favor of Contexts. If you're considering Groups for your project, check out updateContext instead.


Updates the details of an existing group.

How to use?

const res = await orbis.updateGroup(group_id, options);

Parameters

  • group_id - (stream) ID of the group being updated
  • options - object that contains the details of the group
    • pfp - string Profile picture for the group
    • name - string Name of the group
    • description - string Description of the group

Returns

{
  status: 200,
  doc: "kjzl6cwe1...e4wvxhiqj",
  result: "Success creating TileDocument."
}