Create (host) a group decision session

Requires the groups_host scope, and requires the API key owner to have an active subscription — the identical gate the browser's group-hosting flow enforces (PROJECT_OVERVIEW.md section 3.2), re-checked at the database layer, not just here. A key can be scoped to host without also being able to join (groups_join is a separate scope) or vice versa. Costs 1 unit of the key's rate-limit budget per call.

post/groups

Request

  • Base URL: https://localselections.com/api/v1
  • URL: https://localselections.com/api/v1/groups
  • Auth: API key in header X-API-Key

Request body

categoryMode'cuisine' | 'activity'
mechanic'wheel' | 'dice' | 'rps' | 'coinflip' | 'carddraw' | 'magic8ball'
displayNamestring

Response

The created group session and its join code.

idstring required
joinCodestring required
categoryModestring required
mechanicstring required
statusstring required

Changes

No recorded changes to this operation across all 1 revision of this API.