Skip to main content
POST
Create a group

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Any string up to 255 characters. Replaying the same key with the same body within 24h returns the original response; a different body returns 400 idempotency_key_reused. Without a key, a retried request creates a second object.

Body

application/json
name
string
required

Leading and trailing spaces are trimmed.

Required string length: 1 - 100
Example:

"Acme Varsity"

type
enum<string>
default:team

Can't be changed later.

Available options:
team,
pickup
privacy
enum<string>

Defaults to private for a team and public for a pickup group. 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
Maximum string length: 500
level
enum<string>

How competitive the team is.

Available options:
recreational,
intramural,
youth,
high-school,
college,
semi-pro,
pro
city
string
Maximum string length: 100
state
string
Maximum string length: 100
country
string
Maximum string length: 100
metadata
object

Up to 20 key/values of your own (keys up to 40 characters), returned on the group.

Example:

Response

Created

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.