orbis.updateGroup()

Will update the details of an existing Orbis group.

How to use?

let res = await orbis.updateGroup(
    "kjzl6cwe1...e4wvxhiqj",
    {
      pfp: "https://...",
      name: "Orbis Community",
      description: "Official place to discuss Orbis related stuff."
    }
  );

Parameters

  • stream_id: ID of the group being updated
  • content: JSON 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."
  }

Next steps

Explore other parts of the API.

orbis.createGroup()

orbis.createChannel()