Skip to main content
A group is a team or a pickup group in the Hooper app. A session sent to a group shows up there for everyone in it. Your organization’s groups are the ones you create, which are owned by your account’s owner, and the ones you link. Your organization also has its own private group (default: true on the group). Sessions sent without a group land there.

Create a group and send it a game

  • type is team (the default) or pickup. It can’t be changed later.
  • privacy decides who can find and join the group in the app. It defaults to private for a team and public for a pickup group.
  • metadata holds your own ids, as on a session.
  • An Idempotency-Key makes a retried create return the same group instead of a second one. See Idempotency.

What you can do with a group

A team or pickup group your account’s owner already has in the Hooper app can be linked instead of created. GET /v1/groups?linked=false lists the ones you can link.
  • Linking a group that is already linked changes nothing.
  • POST /v1/groups/{id}/unlink stops new sessions to the group. Sessions already sent to it stay readable, and the group itself isn’t changed.
  • A group stays linked only while your account’s owner owns it. If it’s handed to someone else in the app, it’s unlinked.
  • If Hooper linked a group for you that your account’s owner doesn’t own, you can unlink it, but only Hooper support can link it again.

Updating

POST /v1/groups/{id} changes only the fields you send. null clears a field (name can’t be cleared). metadata is merged: each key you send is set, and a key set to "" is removed.

Deleting

DELETE /v1/groups/{id} removes the group from the Hooper app for everyone in it. To stop sending sessions to a group without deleting it, unlink it instead.
  • Sessions already sent to it stay readable through /v1/sessions. New sessions can’t be sent to it.
  • It can’t be undone through the API.
  • A group on a paid plan returns 409 group_has_subscription; its owner deletes it in the Hooper app.