matches

Join a match by name (or by an existing personal token)

Outcomes: joined, waitlisted, already_in, full, or requested when the player's level is outside the match's range, or declared but unconfirmed on a match that takes confirmed levels only (the organizer approves on the match page; a coach's or the club's confirmation seats the player). A player who already played a finished, scored match with the organizer is never held by that organizer's range. A place the organizer holds for the same name ("Danny") refuses the join with 409 name_held, and nothing is written: if it is that person, they take the place on the match page; if not, they join with a fuller name, such as a last name. A name given without a token that a player in the match (seated or waiting) already carries refuses the join with 409 name_seated, and nothing is written: if it is that player, call again with their personal token; if not, join with a fuller name.

post/api/v1/matches/{code}/join

Request

  • Base URL: https://kicksma.sh
  • URL: https://kicksma.sh/api/v1/matches/{code}/join
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

codestring required

Request body

codestring required

The 4-character match code from the link, e.g. kicksma.sh/AB12 → AB12.

namestring

Required unless token is given.

tokenstring

Personal token of an existing player.

emailstring email

Optional. Sends a calendar invite that updates itself.

levelnumber

Needed once when the match has a level range and the player has no level yet.

partnerstring

A fixed-pairs tournament only: the partner's first name. Their spot is reserved with its own invite link (partner.inviteUrl in the answer), which the partner opens to claim it. Omit to join alone: the player is listed as needing a partner. A player already in alone may call again with a partner.

Response

Result

outcome'joined' | 'waitlisted' | 'already_in' | 'full' | 'requested'
nextstring

Changes

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