Skip to main content
POST
Update a group

Authorizations

Authorization
string
header
required

API key issued by Hooper for your organization. There is one environment, production.

Path Parameters

id
string
required
Example:

"grp_412"

Body

application/json

Only the fields you send change. Send null to clear a field; privacy: null goes back to the default.

name
string

Can't be cleared.

Required string length: 1 - 100
privacy
enum<string> | null
Available options:
public,
private,
hidden
description
string | null
Maximum string length: 500
level
enum<string> | null
Available options:
recreational,
intramural,
youth,
high-school,
college,
semi-pro,
pro
city
string | null
Maximum string length: 100
state
string | null
Maximum string length: 100
country
string | null
Maximum string length: 100
metadata
object | null

Merged into the group's metadata: each key you send is set, and a key set to "" is removed. null removes them all. At most 20 keys after the merge.

Response

OK

id
string
Example:

"grp_412"

object
string
Allowed value: "group"
created
integer

Unix seconds.

name
string
Example:

"Acme Varsity"

type
string

Groups you create or link are team or pickup.

Example:

"team"

privacy
enum<string>

Who can find and join it in the Hooper app. public: anyone can find and join. private: anyone can find it; joining needs an invite. hidden: it doesn't show up in search; only people with an invite can see or join it.

Available options:
public,
private,
hidden
description
string | null
level
enum<string> | null

How competitive the team is.

Available options:
recreational,
intramural,
youth,
high-school,
college,
semi-pro,
pro
city
string | null
state
string | null
country
string | null
metadata
object

Your own key/values; {} when there are none.

Example:
linked
boolean

true when the group belongs to your organization and accepts sessions. false for a group you can link (POST /v1/groups/{id}/link).

default
boolean

true for your organization's own group, where a session sent without group lands. It can't be updated, unlinked or deleted.