API reference

Corrects an existing allocation block's time window or its cost, in the connected organization.

Name	In	Type	Required	Description
allocation	path	integer	yes
start_time	body	string	no	The corrected block start time, in H:i (24-hour) format. State this together with end_time or not at all.
end_time	body	string	no	The corrected block end time, in H:i (24-hour) format, strictly after start_time. State this together with start_time or not at all.
cost_cents	body	integer	no	The corrected cost of this block, in integer cents. Omit to leave the stored cost untouched; 0 means the block is free, not that the cost is unknown.

Removes an allocated block of location time from the organization.

Name	In	Type	Required	Description
allocation	path	integer	yes

Stops announcements to one person of the connected organization — a contact or a member who asked to stop (by phone or email), or whose address keeps bouncing.

Name	In	Type	Required	Description
email	body	string	yes	The person's address: a contact or a member of this organization.
note	body	string	no	Why, in your words — "asked by phone". Up to 255 characters; kept with the stop.

Lists the people announcements skip, whether they unsubscribed themselves or an organizer stopped announcements for them: address, whether it was their own unsubscribe or an organizer's stop, when, by whom and the note.

Sends an announcement email to every non-suppressed contact in the connected organization, in one of its programs or divisions (everyone registered in it), or on one of its contact lists.

Name	In	Type	Required	Description
to	body	string: "organization", "program", "division", "list"	no	Who it goes to: organization (every contact of the organization), program or division (everyone registered in it, waitlist excluded), or list (a contact list). Defaults to list.
id	body	integer	no	The id of the program, division or contact list. Not used for the organization.
contact_list_id	body	integer	no	The id of the contact list to send to — the same as to=list with this id.
subject	body	string	yes	The email subject line.
body	body	string	yes	The message body, written as Markdown — **bold**, _italic_, and [links](url) are supported.

List announcements.

Sends one already-sent announcement to ONE of its recipients again — the retry for a soft bounce such as a full mailbox.

Name	In	Type	Required	Description
announcement	path	integer	yes
recipient	path	integer	yes

Creates an area (up to two levels, org-defined labels) in the connected organization.

Name	In	Type	Required	Description
name	body	string	yes	The name of the area to create.
label	body	string	yes	The organization's own name for this level, e.g. 'Borough'.
level	body	integer	yes	1 or 2. A level-2 area must name a level-1 parent_area_id.
parent_area_id	body	integer	no	Required when level is 2; must not be supplied when level is 1.

Lists areas in the connected organization.

Renames an area, changes its label, or moves a second-level area under another top-level area.

Name	In	Type	Required	Description
area	path	integer	yes
name	body	string	no	The new name of the area.
label	body	string	no	The new label of the area.
parent_area_id	body	integer	no	Moves a second-level area under this top-level area, by its exact numeric id in this organization (call list-areas to confirm it). Refused for a top-level area. The move is recorded in the activity log.

Deletes an area from the organization.

Name	In	Type	Required	Description
area	path	integer	yes

Returns full detail for one area, including its immediate children and assigned locations, in the connected organization.

Name	In	Type	Required	Description
area	path	integer	yes

Register.

Re-sends the captain invitation of an organizer-added team that is still awaiting its captain, with a fresh link valid for 7 days — or, with captain_email, invites another captain instead (required after the first one declined).

Name	In	Type	Required	Description
captainInvitation	path	integer	yes
captain_email	body	string	no	Optional. Invite this address instead (design-v2 D-117). Required when the invited captain declined.

Asks a member of the connected organization to pay an amount for something outside registration: emails them a payment link.

Name	In	Type	Required	Description
payer_user_id	body	integer	yes	Who pays: a member of this organization.
description	body	string	yes	What it is for, as the payer will read it (80 characters at most).
amount_cents	body	integer	yes	The amount, in cents (50 to 200000).
program_id	body	integer	no	Optional: the program it is for.
program_team_id	body	integer	no	Optional: the program team it is for (implies its program).
due_on	body	string	no	Optional: the date it is due, YYYY-MM-DD in the organization's time zone, today or later. It stays payable after it.

Cancels an unpaid charge in the connected organization: its payment link stops working.

Name	In	Type	Required	Description
charge	path	integer	yes

Starts payment of a charge the connected organization asked you to pay, via a Stripe-hosted Checkout Session.

Name	In	Type	Required	Description
charge	path	integer	yes

Emails an unpaid charge's payment link to its payer again.

Name	In	Type	Required	Description
charge	path	integer	yes

Creates a named contact list in the connected organization.

Name	In	Type	Required	Description
name	body	string	yes	The name of the new contact list.

Lists the connected organization's contact lists, each with its member count.

Deletes a contact list and its memberships.

Name	In	Type	Required	Description
contactList	path	integer	yes

Get one of contact lists.

Name	In	Type	Required	Description
contactList	path	integer	yes

Sends an announcement email to every non-suppressed contact in the connected organization, in one of its programs or divisions (everyone registered in it), or on one of its contact lists.

Name	In	Type	Required	Description
contactList	path	integer	yes
subject	body	string	yes	The email subject line.
body	body	string	yes	The message body, written as Markdown — **bold**, _italic_, and [links](url) are supported.

Adds a contact by email to a contact list in the connected organization.

Name	In	Type	Required	Description
contactList	path	integer	yes
email	body	string	yes	The contact's email address.
name	body	string	no	The contact's display name, if known.

Corrects one contact's email address on a contact list.

Name	In	Type	Required	Description
contactList	path	integer	yes
contact	path	integer	yes
contact_email	body	string	yes	The corrected email address. Stored lowercased.

Removes a contact from one contact list.

Name	In	Type	Required	Description
contactList	path	integer	yes
contact	path	integer	yes

Imports contacts into a contact list from an existing source (division registrants, a team roster, or organization members).

Name	In	Type	Required	Description
contactList	path	integer	yes
source	body	string	yes	The source to import from: division_registrants, program_team_roster, or organization_members.
source_id	body	integer	yes	The id of the division, program-team instance, or 0 for organization_members (which has no source id).

Mine.

Gives part or all of the caller's own credit with this organization to another member of it.

Name	In	Type	Required	Description
to_user_id	body	integer	yes	The id of the member of this organization to give the credit to.
amount_cents	body	integer	yes	How much, in cents; at most the caller's balance.

Refunds the caller's credit from free agents' fees on a team they paid for in full to the card they paid that team's entry with, capped at what the card paid.

Name	In	Type	Required	Description
registration_id	body	integer	yes	The caller's own registration on the team they paid for in full.
amount_cents	body	integer	no	How much, in cents; at most the credit and what the card paid. Left out: all of it.

Brings back a withdrawn shared discount code, so payers can apply it again under its own limits.

Name	In	Type	Required	Description
discountCode	path	integer	yes

Withdraws a shared discount code (design-v2 D-103).

Name	In	Type	Required	Description
discountCode	path	integer	yes

Updates a division's name, type, maximum number of teams, gender, who can sign up, sort order, or window override.

Name	In	Type	Required	Description
division	path	integer	yes
name	body	string	no	The new name of the division.
type	body	string	no	Either "age_group" or "skill_tier".
max_teams	body	integer	no	Maximum number of TEAMS in this division (D-55): a team takes one place however many players it has, and a free agent takes none until placed in a team. Omit or pass null for no maximum.
men_allowed	body	boolean	no	Whether men may play in this division (D-31, D-37). Omit or null to follow the program's rule. A division plays as Coed, Men's or Women's; it must let men, women or both play.
women_allowed	body	boolean	no	Whether women may play in this division. Omit or null to follow the program's rule.
players_on_field	body	integer	no	Players a side in this division (D-31). Omit or null to follow the program.
women_min_on_field	body	integer	no	Women required on field at once in this division. Omit or null to follow the program.
men_min_on_field	body	integer	no	Men required on field at once in this division. Omit or null to follow the program.
roster_min	body	integer	no	Fewest players on a team's roster in this division. Omit or null to follow the program (or players a side + 2 when this division sets its own players a side).
max_players_per_team	body	integer	no	Most players on a team's roster in this division. Omit or null to follow the program.
accepts_teams	body	boolean	no	Whether teams can sign up for this division (D-42). Defaults to true.
accepts_free_agents	body	boolean	no	Whether free agents (individual players with no team) can sign up for this division (D-42). Defaults to true.
opens_at	body	string	no	When registration opens for this division. Omit to leave unchanged; send an empty value to fall back to the program's own opens_at. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the start of that day there.
closes_at	body	string	no	When registration closes for this division, and it must fall strictly after opens_at once both are resolved. Omit to leave unchanged; send an empty value to fall back to the program's own closes_at. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the END of that day (23:59:59) there.
sort_order	body	integer	no	Display order among the program's divisions.
fee_cents	body	integer	no	Registration fee in cents. Omit to leave unchanged; pass null to clear an override and fall back to the program's own fee.

Removes a division from a program.

Name	In	Type	Required	Description
division	path	integer	yes

Returns full detail for one division in the connected organization.

Name	In	Type	Required	Description
division	path	integer	yes

Puts the caller on a division's on-call bench of substitutes.

Name	In	Type	Required	Description
division	path	integer	yes
waiver_accepted	body	boolean	yes	The caller accepts the program's waiver. Must be true.
signed_name	body	string	yes	The full name the person types to sign the waiver, stored with the acceptance and printed on its record. Ask the person for it; never fill it in from their account.
fee_understood	body	boolean	yes	The caller understands a sub pays the per-game fee. Must be true.

Takes the caller off a division's on-call bench.

Name	In	Type	Required	Description
division	path	integer	yes

Promotes a division's draft games to committed, making the schedule visible to players and ready to distribute.

Name	In	Type	Required	Description
division	path	integer	yes

Distributes a division's committed schedule by emailing it to every non-suppressed contact on one of the connected organization's contact lists.

Name	In	Type	Required	Description
division	path	integer	yes
contact_list_id	body	integer	yes	The id of the contact list to send the schedule to.

Emails each registered player in a division their own team's published games (one email per person, transactional).

Name	In	Type	Required	Description
division	path	integer	yes

Lists the free agents in one division: players registered who are not on a team yet, with their waiver and payment state and when they registered.

Name	In	Type	Required	Description
division	path	integer	yes

Creates a new team in a division from several of its free agents (registrations with no team): one of them, or another email address, is invited as captain, and every other one is emailed an offer of a place they must accept.

Name	In	Type	Required	Description
division	path	integer	yes
name	body	string	yes	The new team's name.
registration_ids	body	array of integer	yes	The selected free agents' registrations, captain included.
captain_registration_id	body	integer	no	One of registration_ids, to invite as captain. Give this or captain_email.
captain_email	body	string	no	Someone else to invite as captain, when none of the free agents is. Give this or captain_registration_id.

Adds one game to a division's schedule.

Name	In	Type	Required	Description
division	path	integer	yes
round_number	body	integer	yes	Which round of the schedule this game belongs to.
scheduled_at	body	string	yes	When this game is scheduled to be played. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; supply a trailing Z or +HH:MM to name an absolute instant.
home_program_team_id	body	integer	yes	The id of the home team's entry in this program. Must already be entered in this division.
away_program_team_id	body	integer	yes	The id of the away team's entry in this program. Must already be entered in this division, and different from the home team.
sub_location_id	body	integer	no	The id of the field to place this game on. Optional — omit to leave the game unplaced. Two games may never occupy the same field at overlapping times.
duration_minutes	body	integer	no	How long this game runs, in minutes. Required if sub_location_id is set.

Lists a division's games, ordered by round then scheduled time.

Name	In	Type	Required	Description
division	path	integer	yes
status	query	string	no	Filter by status: draft, committed, or cancelled. Omit to list every non-cancelled game.

Updates a game's round, scheduled time, or either team, or keeps it where it is although it does not fit the program's settings.

Name	In	Type	Required	Description
division	path	integer	yes
game	path	integer	yes
round_number	body	integer	no	Which round of the schedule this game belongs to.
scheduled_at	body	string	no	When this game is scheduled to be played. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; supply a trailing Z or +HH:MM to name an absolute instant.
home_program_team_id	body	integer	no	The id of the home team's entry in this program. Must already be entered in this division.
away_program_team_id	body	integer	no	The id of the away team's entry in this program. Must already be entered in this division, and different from the home team.
sub_location_id	body	integer	no	The id of the field to place this game on. Two games may never occupy the same field at overlapping times.
duration_minutes	body	integer	no	How long this game runs, in minutes. Required if sub_location_id is set.
keep_here	body	boolean	no	true keeps the game where it is although it does not fit the program's settings (a day it does not play, outside its hours or season, or a field it no longer lists), so the task to regenerate the schedule stops naming it; false takes that back. Moving the game later clears it.

Removes a game from a division's schedule.

Name	In	Type	Required	Description
division	path	integer	yes
game	path	integer	yes
reason	body	string: "Location", "Team", "Officials", "Weather", "Other"	no	For a published game: why it is cancelled. It goes to the make-up queue.
note	body	string	no	What happened, up to 140 characters; required when the reason is Other.

Get one of games.

Name	In	Type	Required	Description
division	path	integer	yes
game	path	integer	yes

Schedules a make-up for a cancelled game waiting in the make-up queue: a new game between the same two teams at the given time and field.

Name	In	Type	Required	Description
division	path	integer	yes
game	path	integer	yes
scheduled_at	body	string	yes	When the make-up starts, Y-m-d H:i:s. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; supply a trailing Z or +HH:MM to name an absolute instant.
sub_location_id	body	integer	yes	The field it is played on.
duration_minutes	body	integer	no	Its length; defaults to the cancelled game's.

Marks a cancelled game in the make-up queue as not made up and gives each paid player their share of the fee (fee divided by their team's games) as credit, which comes off their next registration and lasts a year.

Name	In	Type	Required	Description
division	path	integer	yes
game	path	integer	yes
decision	body	string: "credit"	yes	credit — each paid player's share of the fee, as credit.

Pins a game so regenerating the schedule keeps it where it is (pinned: true), or releases it so the next regenerate may move or replace it (pinned: false).

Name	In	Type	Required	Description
division	path	integer	yes
game	path	integer	yes
pinned	body	boolean	yes	true keeps the game where it is when the schedule is regenerated; false releases it to the generator.

Generates or regenerates a round-robin schedule for a division.

Name	In	Type	Required	Description
division	path	integer	yes
season_start	body	string	yes	ISO date the first round is scheduled on.
interval_days	body	integer	no	Number of days between rounds. Defaults to 7.
pairing	body	string: "seeded", "random"	no	Seeded: close seeds meet first, in the division's seed order. Random: teams and rounds in random order. Omitted: one round robin in entry order.
games_per_team	body	integer	no	Games each team plays (1-60). Past one round robin, rematches with sides swapped. Omitted: one round robin. With an odd team count a team can end one game over.
games_per_week	body	integer	no	Rounds per week (1-3). Defaults to 1.
only_missing	body	boolean	no	Keep every placed game and give slots only to games that have none. Defaults to false (replace every generated game).
slot_order	body	string: "ordered", "random"	no	ordered: first free field and time; random: any free field and time. Defaults to ordered.
expected_program_team_ids	body	array of integer	no	Optional guard. The program-team ids of the division's teams as you last read them (list-program-teams). If a team joined or left since, nothing is generated and the error names who changed.

Puts a division's playoff seeds back in the official standings order.

Name	In	Type	Required	Description
division	path	integer	yes

Get one of playoff seeds.

Name	In	Type	Required	Description
division	path	integer	yes

Moves a team up or down one playoff seed in its division (swapping with its neighbour).

Name	In	Type	Required	Description
division	path	integer	yes
program_team_id	body	integer	yes	The team to move, as get-playoff-seeds names it.
direction	body	string: "up", "down"	yes	up: one seed better; down: one seed worse.

Starts a division's playoffs: locks the seeds, puts the seeded teams on the first round's games, and emails those teams' players their playoff games.

Name	In	Type	Required	Description
division	path	integer	yes

Replaces a division's ENTIRE seed order in one call.

Name	In	Type	Required	Description
division	path	integer	yes
seeds	body	array of object	yes	The WHOLE ordered seed list, first position first. Send [] to reset the division to its default order. Omitting this argument is refused rather than treated as a reset.

Lists a division's seed proposal: the order its teams would be paired in.

Name	In	Type	Required	Description
division	path	integer	yes

Returns a division's league table AND the fixtures it is still missing, from one call: ranked rows with played/won/drawn/lost, goals, goal difference and points; the unscored fixtures by name; and the played/total figures the header states.

Name	In	Type	Required	Description
division	path	integer	yes
view	query	string: "live", "official"	no	live (default) counts every entered score; official counts confirmed, undisputed results only — the table that decides anything.

Adds a new team, or a team that played before (team_id), to a division (or its wait list) in the connected organization and emails its captain an invitation to accept it.

Name	In	Type	Required	Description
division	path	integer	yes
name	body	string	no	The new team's name. Required unless team_id is given.
captain_email	body	string	no	The email address of the person to invite as captain. Required unless team_id is given, in which case it defaults to that team's last captain.
team_id	body	integer	no	A team of this organization that played before, to add again with its own name instead of typing one. Not already in the program.
placement	body	string: "division", "waitlist"	no	"division" takes one of its spots (refused when full); "waitlist" joins its wait list. Defaults to division.

Makes a file of one table of the connected organization — members, teams, rosters, registrations, schedule, standings (needs program_id) or payments — and returns a link to download it, good for 10 minutes.

Name	In	Type	Required	Description
dataset	path	integer	yes
format	query	string: "csv", "xlsx", "json", "pdf"	no	csv (default), xlsx for Excel, json, or pdf (at most 2,000 rows).
q	query	string	no	Search text, as the table's search box (members, teams, rosters, payments).
program_id	query	integer	no	Only this program. Required for standings.
division_id	query	integer	no	Only this division (registrations, standings).
location_id	query	integer	no	Only games at this location (schedule).
status	query	string	no	Payments: the Status filter (e.g. Paid, Unpaid, Refunded). Teams and rosters: readiness (e.g. Payments due, Ready). Registrations: registered, waitlisted, pending_waiver or cancelled.
type	query	string	no	Payments: All, Payments, Refunds or Charges.
when	query	string	no	Payments: All time, Last 7 days, Last 30 days or Last 90 days. Schedule: all, upcoming, staff or held.
role	query	string	no	Members: only people holding this role.
program	query	string	no	Members: only people in the program of this name.
history	query	string	no	Members: anyone, returning, first or idle.
owes	query	string	no	Members: unpaid, waiver, unregistered or noteam.
show	query	string	no	Teams and rosters: current (teams in a program now, the default) or all.
view	query	string	no	Standings: official (default) or live.
sort	query	string	no	Sort column key, as the table's own sort (e.g. name, date, amt).
dir	query	string	no	asc or desc.

Sets the position a referee or crew member holds on one game, such as Assistant or Setup crew; their fee for that game follows the position.

Name	In	Type	Required	Description
assignment	path	integer	yes
position_id	body	integer	yes	The position, from list-official-fees.

Accepts or declines a game you were assigned to as an official or crew member, or undoes your decline.

Name	In	Type	Required	Description
assignment	path	integer	yes
answer	body	string	yes	accept, decline or undo (a decline, while nobody else has been assigned).
reason	body	string	no	Optional, with a decline: why you cannot make it. Only the organization reads it. 500 characters at most.
confirm_overlap	body	boolean	no	Send true to accept anyway after a validation error said the game overlaps one you already accepted.

Confirms a score the other team's captain entered, so it counts in the official standings.

Name	In	Type	Required	Description
gameResult	path	integer	yes

Raises a dispute against a RECORDED result, stating what is being disputed.

Name	In	Type	Required	Description
gameResult	path	integer	yes
reason	body	string	yes	What is being disputed, in the disputer's own terms. A blank or whitespace-only reason is refused — a dispute with no stated grievance cannot resolve to an outcome.

Starts paying the caller's own per-game sub fee online and returns a checkout_url to send them to.

Name	In	Type	Required	Description
gameSubstitute	path	integer	yes

Records what happened to a fixture that produced NO played score: forfeit, abandoned, not_played or cancelled.

Name	In	Type	Required	Description
game	path	integer	yes
result_type	body	string	yes	What happened instead of a played result: forfeit, abandoned, not_played, cancelled. There is no default — omitting this is refused rather than guessed.
forfeit_winner	body	string	no	home or away — the side awarded the forfeit. Required for a forfeit and refused for anything else. The SCORE is decided by Hollis, not by this argument.
home_score	body	integer	no	Goals the HOME team had scored when the game was abandoned. Accepted only for an abandoned game; omit it and nothing is assumed.
away_score	body	integer	no	Goals the AWAY team had scored when the game was abandoned. Accepted only for an abandoned game.
reason	body	string	no	Why the result is being changed. Recorded on the revision when this overwrites an existing result.

Makes one game pay its referees and crew a percentage above or below their usual fee: +20 pays a fifth more, -10 a tenth less, for every position on that game.

Name	In	Type	Required	Description
game	path	integer	yes
percent	body	integer | null	yes	Whole percent above (+) or below (-) the usual fee, -100 to 500; null or 0 clears it.

Records the PLAYED score for a fixture — the two teams turned up and the game finished.

Name	In	Type	Required	Description
game	path	integer	yes
home_score	body	integer	yes	Goals scored by the HOME team. Required — there is no default, and a missing score is refused rather than treated as nil.
away_score	body	integer	yes	Goals scored by the AWAY team. Required, for the same reason as home_score.
reason	body	string	no	Why the result is being changed. Recorded on the revision when this overwrites an existing result; ignored on a first recording.

Removes a game's recorded result, so the game reads as unscored again in standings and the unscored queue.

Name	In	Type	Required	Description
game	path	integer	yes
reason	body	string	no	Why, kept in the result's history. Optional.

Says whether you are playing a game: answer is yes or no, with an optional reason on a no.

Name	In	Type	Required	Description
game	path	integer	yes
answer	body	string	yes	yes or no.
reason	body	string	no	Optional, on a no: why (up to 120 characters).

Emails the RSVP ask again to players on one team of a game who have not answered.

Name	In	Type	Required	Description
game	path	integer	yes
program_team_id	body	integer	yes	Which of the two teams.
user_ids	body	array of integer	no	Optional: only these players (each must be on the team and not have answered).

List rsvps.

Name	In	Type	Required	Description
game	path	integer	yes

Emails the official assigned to a game that has started and has no score, asking for the score with a link to enter it.

Name	In	Type	Required	Description
game	path	integer	yes

Calls the division's bench for substitutes for one published game that has not started, for one team, as many as it is short of the game-ready minimum by yes RSVPs.

Name	In	Type	Required	Description
game	path	integer	yes
program_team_id	body	integer	yes	The per-program team instance that is short.

Lists pending invitations for the connected organization: invitee, role, scope and when the grant ends.

Cancels an invitation to join the organization that has not been accepted; its link stops working.

Name	In	Type	Required	Description
invitation	path	integer	yes

Changes a location custom field's name, value or secret flag.

Name	In	Type	Required	Description
field	path	integer	yes
name	body	string	no	A new name.
value	body	string	no	A new value.
secret	body	boolean	no	Mask the value and log every reveal, or stop doing so.

Removes a custom field from a location.

Name	In	Type	Required	Description
field	path	integer	yes

Reveal.

Name	In	Type	Required	Description
field	path	integer	yes

Creates a location (address, geo, and public detail) in the connected organization.

Name	In	Type	Required	Description
name	body	string	yes	The name of the location to create.
address	body	string	no	The location's street address. Optional: omit it if it is not known yet.
latitude	body	number	no	Latitude, between -90 and 90. Omit if unknown.
longitude	body	number	no	Longitude, between -180 and 180. Omit if unknown.
has_parking	body	boolean	no	Whether the location has parking. Defaults to false.
has_lights	body	boolean	no	Whether the location has lights for night play. Defaults to false.
is_indoor	body	boolean	no	Whether the location is indoor. Defaults to false.
surface	body	string	no	The playing surface (e.g. "grass", "turf"). Omit if unknown.
area_id	body	integer	no	Optional. The area to file the location in, at either level, by its exact numeric id in this organization (call list-areas to confirm it). Omit it to leave the location in no area.

Lists locations in the connected organization.

Changes a location's name, address, indoor/outdoor type, surface or area in the connected organization.

Name	In	Type	Required	Description
location	path	integer	yes
name	body	string	no	The location's new name. Omit to keep it.
address	body	string	no	The location's street address. Omit to keep it; pass an empty string to clear it.
is_indoor	body	boolean	no	Whether the location is indoor. Omit to keep it.
surface	body	string	no	The playing surface (e.g. "grass", "turf"). Omit to keep it; pass an empty string to clear it.
area_id	body	integer	no	The id of the area to assign the location to. Omit to keep it.

Returns full detail for one location, including its fields, in the connected organization.

Name	In	Type	Required	Description
location	path	integer	yes

Sets (creates or updates) the access-block details for a location: permit/booking reference, site contact, after-hours number, gate code, light-panel code, and keyholder.

Name	In	Type	Required	Description
location	path	integer	yes
permit_or_booking_reference	body	string	no	The permit or booking reference for this location. Omit to leave unset.
site_contact	body	string	no	The site or city contact for this location. Omit to leave unset.
after_hours_number	body	string	no	An after-hours contact number for this location. Omit to leave unset.
gate_code	body	string	no	The gate access code for this location. Omit to leave unset.
light_panel_code	body	string	no	The light-panel access code for this location. Omit to leave unset.
keyholder	body	string	no	The name of the person who holds keys for this location. Omit to leave unset.

Reveal.

Name	In	Type	Required	Description
location	path	integer	yes

Allocates a block of a location's permitted time to a program, in the connected organization.

Name	In	Type	Required	Description
location	path	integer	yes
permit_id	body	integer	yes	The id of the permit covering this block, either directly on the location or on one of its fields.
program_id	body	integer	yes	The id of the program this time is allocated to.
date	body	string	yes	The date this block occurs on (date string).
start_time	body	string	yes	The block start time, in H:i (24-hour) format.
end_time	body	string	yes	The block end time, in H:i (24-hour) format, strictly after start_time.
cost_cents	body	integer	yes	The cost of this block, in integer cents.
held_for_makeup	body	boolean	no	Whether this block is being held in reserve for a makeup game.

Lists every block of time allocated on one location in the connected organization.

Name	In	Type	Required	Description
location	path	integer	yes

Adds a custom field (name and value) to a location.

Name	In	Type	Required	Description
location	path	integer	yes
name	body	string	yes	The field name, e.g. "Gate code". Up to 100 characters.
value	body	string	no	The value. Up to 1000 characters.
secret	body	boolean	no	Mask the value and log every reveal.

Lists a location's custom fields (name and value).

Name	In	Type	Required	Description
location	path	integer	yes

Creates a permit naming exactly one of a location or a field it covers, in the connected organization.

Name	In	Type	Required	Description
location	path	integer	yes
sub_location_ids	body	array of integer	no	With location_id: the ids of the location's fields this permit covers. Omit for the whole location.
valid_from	body	string	yes	The date this permit becomes valid (date string).
valid_to	body	string	yes	The date this permit expires, strictly after valid_from.
days	body	array of integer	yes	The weekdays this permit covers, as ISO weekday numbers: 1 is Monday through 7 is Sunday, as a program's game_days. English names ("monday") are accepted too; the permit reads back numbers.
start_time	body	string	yes	The daily start time, in H:i (24-hour) format.
end_time	body	string	yes	The daily end time, in H:i (24-hour) format, strictly after start_time.
reference_number	body	string	yes	The permit or booking reference number.
status	body	string	no	The permit's status: approved, pending or not_requested (default approved). Field time is usable only inside an approved or pending permit; games on a pending one are At risk; a not_requested permit grants nothing.

Creates a field under a location in the connected organization.

Name	In	Type	Required	Description
location	path	integer	yes
name	body	string	yes	The name of the field to create.

Lists a location's fields, in the connected organization.

Name	In	Type	Required	Description
location	path	integer	yes

Lists members of the connected organization.

Invites a user to join the connected organization under a named role.

Name	In	Type	Required	Description
email	body	string	yes	The email address to invite.
role_name	body	string	yes	The role to assign the invitee.
name	body	string	no	Optional. The invitee's name, up to 120 characters, shown beside the address in the invitation list until it is accepted. A label only: the account's own name replaces it.
scope_type	body	string	no	Optional. Narrows the grant the invitation confers to one subject instead of the whole organization: one of organization, area, program, division, location. Omit it, or pass "organization", for reach across the whole organization. On a RE-SEND to an address that already has a live invitation, omitting this KEEPS whatever scope that invitation already names — pass "organization" to deliberately widen it.
scope_id	body	integer	no	Required when scope_type names something narrower than the organization, and refused otherwise. Must be the exact numeric id of a subject in THIS organization — never a name and never an id you are inferring; call the matching list tool to confirm it first.
grant_expires_at	body	string	no	Optional end date for the GRANT, as YYYY-MM-DD. Not the same clock as the invitation link, which always dies after 7 days: this is when the access the invitee accepts stops. The grant ends at 23:59 on that date in the organization's own timezone. OMITTING THIS MEANS THE GRANT NEVER EXPIRES — say so to the human rather than leaving it unsaid. On a RE-SEND, omitting it keeps whatever end date the live invitation already names.

Revokes a member's access to the connected organization.

Name	In	Type	Required	Description
user	path	integer	yes

Returns one member's credit with the connected organization: the balance, every part of it (available, held, spent or expired) with its source and expiry date, and each use of it (toward a payment, given to another member, or withdrawn to a card).

Name	In	Type	Required	Description
user	path	integer	yes

Changes a member's role within the connected organization.

Name	In	Type	Required	Description
user	path	integer	yes
role_name	body	string	yes	The role to assign.
scope_type	body	string	no	Optional. Narrows the grant to one subject instead of the whole organization: one of organization, area, program, division, location. Omit it, or pass "organization", for reach across the whole organization.
scope_id	body	integer	no	Required when scope_type names something narrower than the organization, and refused otherwise. Must be the exact numeric id of a subject in THIS organization — never a name and never an id you are inferring; call the matching list tool to confirm it first.
expires_at	body	string	no	Optional end date as YYYY-MM-DD. The grant ends at 23:59 on that date in the organization's own timezone, whatever zone you express it in. OMITTING THIS MEANS THE GRANT NEVER EXPIRES — say so to the human rather than leaving it unsaid.

Lists YOUR OWN messages in this organization, newest first: what your teams, their captains and the organizers wrote to you, and what you wrote.

Hides a player’s or captain’s message written to the organizers (from organizer-messages), or shows it again with hidden false.

Name	In	Type	Required	Description
message	path	integer	yes
hidden	body	boolean	no	true (default) hides it; false shows it again.

Answers a message from my-messages.

Name	In	Type	Required	Description
message	path	integer	yes
body	body	string	yes	The reply, up to 2000 characters.

Records an absolute away window — a start date and an end date — for the connected user, for dates they will be unavailable to officiate.

Name	In	Type	Required	Description
starts_on	body	string	yes	The first day of the absence, as YYYY-MM-DD. Required — an away window with one bound missing is refused, never stored half-open.
ends_on	body	string	yes	The last day of the absence, as YYYY-MM-DD. Required, and may not be earlier than starts_on. Pass the same date as starts_on for a single-day absence.
reason	body	string	no	Optional free text, at most 255 characters, describing the absence. Never a standing preference — this field records why the official is away, not which days they would rather not work.

Removes one of the connected user's own absolute away windows, by its id.

Name	In	Type	Required	Description
awayWindow	path	integer	yes

Get one of my bank account.

Starts connecting the connected user’s own bank account through Stripe so they can be paid as a referee or crew member, or, once connected, opens Stripe to change it.

Declares which areas the connected user will officiate in, replacing their current declaration.

Name	In	Type	Required	Description
area_ids	body	array of integer	yes	The ids of the areas this official will work in, at either of the organization's two area levels. An empty list declares that they will work nowhere. Ticking a level-1 area is stored as that area, never expanded into its children.

Lists the areas the connected user has declared they will officiate in, for this organization.

Mine.

Lists YOUR OWN open placement offers: teams that have offered you, a free agent, a place (or, with moves_from_team_name set, a move off the team you are on), and when each offer closes.

Lists the registrations belonging to the connected user in this organization.

Lists the upcoming committed games for the teams the connected user is on in this organization.

Mine.

Lists the teams the connected user is on in this organization, and flags which ones they captain.

Name	In	Type	Required	Description
captain_only	query	boolean	no	When true, returns only the teams the connected user captains.

Changes the organization’s agreement for referees and crew.

Name	In	Type	Required	Description
body	body	string	no	The agreement’s full text, in the organization’s own words. A change saves a new version.
asks	body	boolean	no	Ask officials to sign the agreement.
sign_first	body	boolean	no	An official must sign the current version before accepting a game.

Get one of official agreement.

Sets the fee per game for one position: the organization default (no program_id or game_id), one program’s own fee (program_id), or one game’s own fee (game_id).

Name	In	Type	Required	Description
position_id	body	integer	yes	The position, from list-official-fees.
program_id	body	integer	no	Set this program’s own fee. Omit for the organization default.
game_id	body	integer	no	Set one game’s own fee. Never with program_id.
fee_cents	body	integer | null	yes	The fee per game in cents, 0 to 1000000; null clears it.

List official fees.

List official pay.

Adds a position for referees and crew, such as Line judge, on the Referee side or the Crew side.

Name	In	Type	Required	Description
name	body	string	yes	The position, at most 60 characters.
side	body	string: "official", "crew"	yes	official for the Referee side, crew for the Crew side.

Removes a position for referees and crew.

Name	In	Type	Required	Description
position	path	integer	yes

Get one of organization.

Provisions the connected organization's default sending subdomain, or (with custom_hostname) upgrades to a custom domain.

Name	In	Type	Required	Description
custom_hostname	body	string	no	An optional custom domain to send from instead of the auto-provisioned default subdomain, e.g. announce.theirclub.com. Omit to provision (or leave unchanged) the default.

Reads the connected organization's sending identity: hostname, verification status, and (while pending) the DNS records still to add.

Re-checks DKIM and Return-Path verification for the connected organization's sending domain and reports the current status, including which check is still outstanding if verification has not completed.

Updates the bound organization's mail settings.

Name	In	Type	Required	Description
postal_address	body	string	no	The organization's physical postal address, shown in the footer of every announcement email as required by United States CAN-SPAM law. At least 10 characters.
announcement_sender	body	string	no	The part before the @ that announcements are sent as, such as "info", on the organization's own sending domain (a full address on that domain is accepted). Only for an organization that set up its own domain; empty sends as "announcements". An address on any other domain is refused.

Updates the bound organization's payment settings: refund approval, unpaid-registration hold duration, refund fees, the processing charge, and the default withdrawal terms (full-refund deadline and what is refunded after it).

Name	In	Type	Required	Description
refund_requires_approval	body	boolean	no	Whether a refund must be approved by a second organizer before it is sent. Defaults to true for every organization.
payment_hold_minutes	body	integer	no	How many minutes an unpaid registration holds its slot before the hold lapses. Must be at least 1.
refund_keeps_fees	body	boolean	no	Whether a refund keeps back Stripe's processing fee, so refunds never cost the organization money. On by default. Applies to payments made after the change; players are told before they pay.
pass_on_processing	body	boolean	no	Default for every program: whether the payer is charged Stripe's card processing fee as its own checkout line (true) or the organization absorbs it (false, the default). Stripe's full fee on the card total, so the organization receives the price. A program can differ. Applies to payments started from then on.
full_refund_days_before_first_game	body	integer	no	Default for every program: a player may withdraw for a full refund, on their own, until this many days before the first game (0 to 365; 14 by default). After that only an organizer can withdraw them. A program can differ. Applies to registrations taken from then on; players are told before they pay.
after_full_refund_window	body	string: "unplayed_share", "none"	no	Default for every program: what a withdrawal after that deadline refunds — unplayed_share (the share of the season not yet played, the default) or none. A program can differ. Applies to registrations taken from then on.

Starts connecting the organization's own Stripe account so it can take payments.

Disconnects the organization's Stripe account so it can be connected again from scratch (for example after signing in to the wrong Stripe login).

The organization's name, web address (slug — NAME.hollisapp.com; changeable only until its first program is published), sport (sports: a list from the fixed set; one unless multi_sport is true — a label, it gates nothing) and time zone (an IANA name every game time is shown in).

Name	In	Type	Required	Description
name	body	string	no	At most 60 characters.
slug	body	string	no	Lowercase letters, numbers and hyphens, 3–30 characters.
timezone	body	string	no	An IANA time zone, e.g. America/New_York.
sports	body	array of string	no	From: Soccer, Basketball, Volleyball, Softball, Hockey, Pickleball, Tennis, Flag football, Ultimate, Kickball, Other.
multi_sport	body	boolean	no	true for several sports; false (the default) for exactly one.

Whether the organization asks players their gender (asks_gender; on by default, asked once and kept on the player, never collected when off), and whether a sub may play for more than one team in a program (subs_multiple_teams; on by default, one team only when off — never both sides of one game either way).

Name	In	Type	Required	Description
asks_gender	body	boolean	no	true asks players their gender once and keeps it; false never collects it.
subs_multiple_teams	body	boolean	no	true lets a sub play for several teams in a program; false limits a sub to the one team they play or first subbed for.

Organization index.

Organization destroy.

Name	In	Type	Required	Description
id	path	integer	yes

Creates a new organization owned by the connected user.

Name	In	Type	Required	Description
name	body	string	yes	The name of the organization to create.
timezone	body	string	no	IANA timezone identifier for the organization, e.g. "America/New_York". Every program and division registration window is interpreted in this zone. Defaults to UTC.

Registers the connected user for a division in the connected organization, accepting the current waiver.

Name	In	Type	Required	Description
organization	path	string	yes	The organization's slug, as in its web address.
division	path	integer	yes
waiver_accepted	body	boolean	yes	Must be true — confirms the connected user accepts the organization's current waiver.
signed_name	body	string	yes	The full name the person types to sign the waiver, stored with the acceptance and printed on its record. Ask the person for it; never fill it in from their account.
program_team_id	body	integer	no	Optional. Joins this existing team instance of the same program. Mutually exclusive with team_name.
team_name	body	string	no	Optional. Creates a new team with this name and joins it. Mutually exclusive with program_team_id. Does not confer captaincy.
bring_back_program_team_id	body	integer	no	Optional. Bring back a team the connected user CAPTAINED in an earlier program here: the id of that earlier team instance. The team enters this program with them as captain (a different team_name starts a new team instead). Refused for any team they did not captain.
bring_back_keep	body	array of integer	no	Optional, with bring_back_program_team_id. User ids of that earlier team's players to invite back; each gets their own invitation and joins only by accepting. Ids not on that team are ignored.
bring_back_add	body	array of string	no	Optional, with bring_back_program_team_id. New email addresses to invite to the team.
answers	body	array of object	no	Your answers to the program's registration questions. Questions you leave out keep your most recent earlier answer.
gender	body	string	no	woman, man, non_binary or prefer_not_to_say. Asked once and kept on your account; needed where the organization asks it and you have none on file.

Asks this organization to email an address when a program opens for registration in an area (a level-1 area includes its level-2 areas), or, with no area, when any of its programs opens.

Name	In	Type	Required	Description
organization	path	string	yes	The organization's slug, as in its web address.
email	body	string	yes	The address to email. Its owner must confirm before anything but the confirmation is sent.
area_id	body	integer	no	An area of this organization (list-areas); a level-1 area includes its level-2 areas. Leave it out for any area: every program the organization opens is covered.

Writes a message to everyone on one team (to team), on every team in a division (to division), in a game (to game: both teams and its officials), to one member (to person), or to everyone in a current program plus staff (to organization).

Name	In	Type	Required	Description
to	body	string	no	team, division, game, person or organization. Omit when sending targets.
id	body	integer	no	The program team id (to team), division id (to division), game id (to game) or user id (to person); none for organization.
targets	body	array of object	no	Several recipients for one message, up to 50. Use instead of to and id.
body	body	string	yes	The message, up to 2000 characters.

Lists the organizers’ messages: box inbox (default) is what players and captains wrote to the organizers, each thread with its replies; box sent is what organizers wrote to a team, division or program.

Name	In	Type	Required	Description
box	query	string	no	inbox (default) or sent. Any other value is refused.

Lists the connected organization's payments, newest first: invoice, payer, amount, status, what went back to a card (refunded_cents) and as credit (credited_cents), and what it was for.

Lists permits in the connected organization, soonest to expire first.

Sparse-updates a permit's valid_to/days/start_time/end_time/status, and which of its location's fields it covers (sub_location_ids; an empty list = the whole location), in the connected organization.

Name	In	Type	Required	Description
permit	path	integer	yes
sub_location_ids	body	array of integer	no	Which of the location's fields the permit covers; an empty list = the whole location. Dropping a field is recorded as a narrowing.
valid_to	body	string	no	The new expiry date (date string), strictly after valid_from.
days	body	array of integer	no	The new set of weekdays this permit covers, as ISO weekday numbers: 1 is Monday through 7 is Sunday. English names are accepted too.
start_time	body	string	no	The new daily start time, in H:i (24-hour) format.
end_time	body	string	no	The new daily end time, in H:i (24-hour) format, strictly after start_time.
status	body	string	no	The permit's status: approved, pending or not_requested (default approved). Field time is usable only inside an approved or pending permit; games on a pending one are At risk; a not_requested permit grants nothing.

Returns full detail for one permit in the connected organization.

Name	In	Type	Required	Description
permit	path	integer	yes

Lists a permit's change events (edits that narrowed a previously-granted window), in the connected organization.

Name	In	Type	Required	Description
permit	path	integer	yes

Accepts or declines one of YOUR OWN placement offers (see my-placement-offers).

Name	In	Type	Required	Description
placementOffer	path	integer	yes

Accepts or declines one of YOUR OWN placement offers (see my-placement-offers).

Name	In	Type	Required	Description
placementOffer	path	integer	yes

Removes an invited email from an invite-only program: their link stops working and they can no longer register.

Name	In	Type	Required	Description
programInvitation	path	integer	yes

Removes a team's per-program instance from a program.

Name	In	Type	Required	Description
programTeam	path	integer	yes

Returns full detail for one per-program team instance in the connected organization.

Name	In	Type	Required	Description
programTeam	path	integer	yes

Switches automatic sub calls on or off for one team.

Name	In	Type	Required	Description
programTeam	path	integer	yes
on	body	boolean	yes	true to call the bench automatically at T-48h when short; false for the captain's tap only.

Invites players from last season's roster to the team you captain, each from you; every one answers for themselves and nobody is placed, paid or signed until they do.

Name	In	Type	Required	Description
programTeam	path	integer	yes
user_ids	body	array of integer	no	The players to invite, from list-bring-back-players. Omit to invite everyone offered. An id that is not offered is ignored and returned in not_offered.

Lists the players the captain of a team could bring back from its last season: the people on the roster of the newest earlier season of the same team that this captain led, not already on a team in this program or invited to this one.

Name	In	Type	Required	Description
programTeam	path	integer	yes

Lists organization members who could be added to one program-team instance's roster in the connected organization — members not already rostered anywhere in that program.

Name	In	Type	Required	Description
programTeam	path	integer	yes
players_only	query	boolean	no	Optional. True leaves out members who hold the Owner, Admin or Staff role (you too, if you are one). Default false: organizers play, so they are listed, marked is_staff.

Assigns or clears the captain of a per-program team instance in the connected organization.

Name	In	Type	Required	Description
programTeam	path	integer	yes
captain_user_id	body	integer	no	The id of the organization member to make captain. Omit this field entirely to clear the current captaincy.

Names or clears the co-captain of a per-program team instance: a second full captain (roster, payment, results) for that one team.

Name	In	Type	Required	Description
programTeam	path	integer	yes
co_captain_user_id	body	integer	no	The id of the organization member to make co-captain. Omit this field entirely to clear the co-captaincy.

Writes a message for one of YOUR teams.

Name	In	Type	Required	Description
programTeam	path	integer	yes
audience	body	string	yes	team, captains, player or organizers.
body	body	string	yes	The message, up to 2000 characters.
recipient_user_id	body	integer	no	For audience player: the player on your team.
share	body	boolean	no	For audience organizers: let the rest of the team see it.

Chooses who pays for one team's entry.

Name	In	Type	Required	Description
programTeam	path	integer	yes
captain_pays	body	boolean	yes	true: the captain pays for the whole team; false: each player pays their share.

Registers every player on a program-team instance's roster into a division of the connected organization.

Name	In	Type	Required	Description
programTeam	path	integer	yes
division_id	body	integer	yes	The id of the division to register the roster into.

Moves every active registration on a program-team instance's roster to a different division of the SAME program, in one call.

Name	In	Type	Required	Description
programTeam	path	integer	yes
division_id	body	integer	yes	The id of the target division, within the same program as the roster's registrations.

Starts a bulk payment covering every payable registration on a program-team instance's roster, for one division, via a single Stripe-hosted Checkout Session.

Name	In	Type	Required	Description
programTeam	path	integer	yes
division_id	body	integer	yes	The id of the division these registrations belong to.

Resigns the caller's own captaincy (or co-captaincy) of a per-program team instance; they stay on the roster as a player.

Name	In	Type	Required	Description
programTeam	path	integer	yes

Adds a player to one program-team instance's roster in the connected organization.

Name	In	Type	Required	Description
programTeam	path	integer	yes
user_id	body	integer	yes	The id of the user to add. Must already be a member of this organization.

Lists the players on one program-team instance's roster in the connected organization.

Name	In	Type	Required	Description
programTeam	path	integer	yes

Removes a player from a program-team instance's roster.

Name	In	Type	Required	Description
programTeam	path	integer	yes
user	path	integer	yes

Puts a player who was removed from a team back on its roster, with the registration the removal cancelled (if it has not changed since) and the captain or co-captain role the removal cleared (if nobody holds it now).

Name	In	Type	Required	Description
programTeam	path	integer	yes
user	path	integer	yes

Issues a team invitation to one program-team instance's roster in the connected organization.

Name	In	Type	Required	Description
programTeam	path	integer	yes
email	body	string	yes	The email address to invite.
name	body	string	no	Optional. The invitee's name, up to 120 characters, kept with the invitation as a label until it is accepted. The roster still shows the address you invited (D-207).

Lists the invitations sent to join a team, for one program (program_id) or one team (program_team_id): who was invited, whether it is pending, accepted, cancelled or expired, and when.

Name	In	Type	Required	Description
programTeam	path	integer	yes
status	query	string	no	Narrow to one status: pending, accepted, cancelled, expired.

Takes back an invitation to a program-team instance's roster that nobody has accepted; its link stops working.

Name	In	Type	Required	Description
programTeam	path	integer	yes
teamInvitation	path	integer	yes

Moves a team off its spot in a division and back onto that division's wait list, freeing the spot.

Name	In	Type	Required	Description
programTeam	path	integer	yes
division_id	body	integer	yes	The division whose spot it gives up.

Creates a reusable program template in the connected organization.

Name	In	Type	Required	Description
name	body	string	yes	The name of the template to create, as an organizer would recognise it — for example "7v7 Coed".
players_on_field	body	integer	no	How many players each side fields at once: the 7 in "7v7".
max_teams	body	integer	no	The maximum number of TEAMS. It is a team count: a program created from this template stores it on that program's default division, beside the division's capacity, which counts player slots and is a different number. Omit for no team maximum.
roster_min	body	integer	no	The minimum number of players on a team roster. A program created from this template derives it from players_on_field when the template names none.
max_players_per_team	body	integer	no	The maximum roster size. Omit for no maximum; do not send 0 to mean that.
game_periods	body	integer	no	How many periods a game is played in.
game_period_minutes	body	integer	no	How many minutes each period lasts.
game_break_minutes	body	integer	no	How many minutes of break sit between periods.
men_allowed	body	boolean	no	Whether men may play. Defaults to true.
men_min_on_field	body	integer	no	The minimum number of men required on the field. Omit for no requirement; 0 is a requirement of none, which is a different rule.
women_allowed	body	boolean	no	Whether women may play. Defaults to true.
women_min_on_field	body	integer	no	The minimum number of women required on the field. Omit for no requirement; 0 is a requirement of none, which is a different rule.
fee_cents	body	integer	no	The registration fee in CENTS, not in currency units — 5000 is fifty dollars.
registration_opens_weeks_before	body	integer	no	How many weeks BEFORE the first game registration opens. A template holds no dates at all, only this offset; the anchor date is supplied on the program at create time. May be negative, which means registration opens after the season has started.
registration_closes_days_before	body	integer	no	How many days BEFORE the first game registration closes. A template holds no dates at all, only this offset; the anchor date is supplied on the program at create time. May be negative, which means late entry is accepted after the season has started.
weeks_of_play	body	integer	no	How many weeks of regular season are played.
playoff_weeks	body	integer	no	How many weeks of playoffs are played. Omit for a season with no playoffs at all; 0 means a playoffs period of no length, which is a different fact.
settings	body	object	no	The long tail of authored settings that no screen renders — officials per kind and their rates, points and tiebreakers, custom-field ids. Nothing here is filterable or sortable; a fact that needs to be either is a column, not a settings key.

Lists the reusable program templates in the connected organization, optionally filtered by format, gender or length.

Name	In	Type	Required	Description
format	query	integer	no	Keep only templates whose players_on_field equals this exactly — the 7 in "7v7". Omit for any format.
gender	query	string	no	One of "coed", "mens" or "womens". Reads the two allowed-to-play booleans; omit for any gender.
length	query	integer	no	Keep only templates whose weeks_of_play equals this exactly. Omit for any length.
sort	query	string	no	One of "name", "players_on_field", "fee_cents", "weeks_of_play" or "created_at". Defaults to name. Gender is deliberately not sortable — it is two columns, not one.

Edits an existing program template in the connected organization.

Name	In	Type	Required	Description
programTemplate	path	integer	yes
name	body	string	no	A new name for the template. Renaming does NOT change the template's slug, which stays the durable public identifier.
players_on_field	body	integer	no	How many players each side fields at once: the 7 in "7v7".
max_teams	body	integer	no	The maximum number of TEAMS. It is a team count: a program created from this template stores it on that program's default division, beside the division's capacity, which counts player slots and is a different number. Omit for no team maximum.
roster_min	body	integer	no	The minimum number of players on a team roster. A program created from this template derives it from players_on_field when the template names none.
max_players_per_team	body	integer	no	The maximum roster size. Omit for no maximum; do not send 0 to mean that.
game_periods	body	integer	no	How many periods a game is played in.
game_period_minutes	body	integer	no	How many minutes each period lasts.
game_break_minutes	body	integer	no	How many minutes of break sit between periods.
men_allowed	body	boolean	no	Whether men may play. Defaults to true.
men_min_on_field	body	integer	no	The minimum number of men required on the field. Omit for no requirement; 0 is a requirement of none, which is a different rule.
women_allowed	body	boolean	no	Whether women may play. Defaults to true.
women_min_on_field	body	integer	no	The minimum number of women required on the field. Omit for no requirement; 0 is a requirement of none, which is a different rule.
fee_cents	body	integer	no	The registration fee in CENTS, not in currency units — 5000 is fifty dollars.
registration_opens_weeks_before	body	integer	no	How many weeks BEFORE the first game registration opens. A template holds no dates at all, only this offset; the anchor date is supplied on the program at create time. May be negative, which means registration opens after the season has started.
registration_closes_days_before	body	integer	no	How many days BEFORE the first game registration closes. A template holds no dates at all, only this offset; the anchor date is supplied on the program at create time. May be negative, which means late entry is accepted after the season has started.
weeks_of_play	body	integer	no	How many weeks of regular season are played.
playoff_weeks	body	integer	no	How many weeks of playoffs are played. Omit for a season with no playoffs at all; 0 means a playoffs period of no length, which is a different fact.
settings	body	object	no	The long tail of authored settings that no screen renders — officials per kind and their rates, points and tiebreakers, custom-field ids. Nothing here is filterable or sortable; a fact that needs to be either is a column, not a settings key.

Removes a program template from the connected organization.

Name	In	Type	Required	Description
programTemplate	path	integer	yes

Get one of program templates.

Name	In	Type	Required	Description
programTemplate	path	integer	yes

Creates a new program from a program template in the connected organization.

Name	In	Type	Required	Description
programTemplate	path	integer	yes
name	body	string	yes	The name of the program to create. Required: a template states a shape, not a season, so the new program is never named for you.
description	body	string	no	An optional description of the program. A template carries none — it is prose about one season.
first_game_on	body	string	no	The date of the first game, as YYYY-MM-DD. This is the ANCHOR a template deliberately does not hold: supplying it together with the template's registration offsets DERIVES opens_at and closes_at, and the derived value wins over an opens_at or closes_at sent in the same call.
opens_at	body	string	no	When registration opens. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the start of that day there.
closes_at	body	string	no	When registration closes, and it must fall strictly after opens_at once both are resolved. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the END of that day (23:59:59) there.
game_days	body	array of integer	no	The days of the week games are played on, as ISO weekday numbers: 1 is Monday through 7 is Sunday. A template carries none — the weekday a season plays on is a fact about that season.
fee_cents	body	integer	no	The registration fee in CENTS, not in currency units. Omit to keep the template's fee.
weeks_of_play	body	integer	no	Overrides the template's weeks of regular season.
playoff_weeks	body	integer	no	Overrides the template's weeks of playoffs.
registration_opens_weeks_before	body	integer	no	Overrides how many weeks before the first game registration opens. May be negative. Ignored when there is no first_game_on to measure from.
registration_closes_days_before	body	integer	no	Overrides how many days before the first game registration closes. May be negative. Ignored when there is no first_game_on to measure from.
players_on_field	body	integer	no	Overrides how many players each side fields at once: the 7 in "7v7".
roster_min	body	integer	no	Overrides the minimum number of players on a team roster.
max_players_per_team	body	integer	no	Overrides the maximum roster size.
max_teams	body	integer	no	Overrides the maximum number of TEAMS. Stored on the new program's default division, beside its capacity, which counts player slots and is a different number.
game_periods	body	integer	no	Overrides how many periods a game is played in.
game_period_minutes	body	integer	no	Overrides how many minutes each period lasts.
game_break_minutes	body	integer	no	Overrides how many minutes of break sit between periods.
men_allowed	body	boolean	no	Overrides whether men may play.
men_min_on_field	body	integer	no	Overrides the minimum number of men required on the field. 0 is a requirement of none, which is a different rule from no requirement at all.
women_allowed	body	boolean	no	Overrides whether women may play.
women_min_on_field	body	integer	no	Overrides the minimum number of women required on the field. 0 is a requirement of none, which is a different rule from no requirement at all.

Creates a new program (season) in the connected organization, starting in draft visibility.

Name	In	Type	Required	Description
name	body	string	yes	The name of the program to create.
description	body	string	no	An optional description of the program.
opens_at	body	string	no	When registration opens. Any value WITHOUT an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the start of that day there. Supply a trailing Z or +HH:MM to name an absolute instant instead.
closes_at	body	string	no	When registration closes, and it must fall strictly after opens_at once both are resolved. Any value WITHOUT an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the END of that day (23:59:59) there, not UTC midnight. Supply a trailing Z or +HH:MM to name an absolute instant instead.
first_game_on	body	string	no	The date of the first game, as YYYY-MM-DD. This is the ANCHOR: supplying it together with registration_opens_weeks_before or registration_closes_days_before DERIVES opens_at / closes_at from it, and the derived value wins over an opens_at or closes_at sent in the same call.
weeks_of_play	body	integer	no	How many weeks of regular season are played. Omitted, with max_teams sent: the weeks a full round robin at max_teams needs, one round a week.
playoff_weeks	body	integer	no	How many weeks of playoffs are played. Omit for a season with no playoffs at all; 0 means a playoffs period of no length, which is a different fact.
registration_opens_weeks_before	body	integer	no	How many weeks before the first game registration opens. May be negative, which means registration opens after the season has started. Ignored when there is no first_game_on to measure from.
registration_closes_days_before	body	integer	no	How many days before the first game registration closes. May be negative, which means late entry is accepted after the season has started. Ignored when there is no first_game_on to measure from.
game_days	body	array of integer	no	The days of the week games are played on, as ISO weekday numbers: 1 is Monday through 7 is Sunday. Every week is played on every day listed.
game_day_hours	body	object	no	The window games may be played in on each game day, keyed by ISO weekday (1 Monday .. 7 Sunday): {"2": {"from": "18:00", "to": "22:00"}}. Times are HH:MM, to after from.
players_on_field	body	integer	no	How many players each side fields at once: the 7 in "7v7".
roster_min	body	integer	no	The minimum number of players on a team roster. Defaults to players_on_field plus two when omitted.
max_players_per_team	body	integer	no	The maximum roster size. Omit for no maximum; do not send 0 to mean that.
max_teams	body	integer	no	The maximum number of TEAMS. Stored on the program's default division, beside its capacity, which counts player slots and is a different number. Omit for no team maximum.
game_periods	body	integer	no	How many periods a game is played in.
game_period_minutes	body	integer	no	How many minutes each period lasts.
game_break_minutes	body	integer	no	How many minutes of break sit between periods.
men_allowed	body	boolean	no	Whether men may play. Defaults to true.
men_min_on_field	body	integer	no	The minimum number of men required on the field. Omit for no requirement; 0 is a requirement of none, which is a different rule.
women_allowed	body	boolean	no	Whether women may play. Defaults to true.
women_min_on_field	body	integer	no	The minimum number of women required on the field. Omit for no requirement; 0 is a requirement of none, which is a different rule.

Lists programs in the connected organization.

Name	In	Type	Required	Description
archived	query	boolean	no	true lists the archived programs instead of the others, so one can be brought back with unarchive-program.

Updates a program's name, description, registration window or season shape, or flips its early-close switch.

Name	In	Type	Required	Description
program	path	integer	yes
name	body	string	no	The new name of the program.
description	body	string	no	The new description of the program.
opens_at	body	string	no	When registration opens. Any value WITHOUT an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the start of that day there. Supply a trailing Z or +HH:MM to name an absolute instant instead. To open registration now, ahead of its window, send the current time (the program page's "Open registration now").
closes_at	body	string	no	When registration closes, and it must fall strictly after opens_at once both are resolved. Any value WITHOUT an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the END of that day (23:59:59) there, not UTC midnight. Supply a trailing Z or +HH:MM to name an absolute instant instead.
registration_manually_closed	body	boolean	no	Set true to close registration early without changing the program's visibility or dates — set back to false to reopen it just as cheaply.
fee_cents	body	integer	no	Registration fee in cents. Omit to leave unchanged; pass null to clear the fee.
full_refund_days_before_first_game	body	integer	no	How many days before the first game a registrant can still withdraw for a FULL refund. Until then the registrant can withdraw on their own; after it only an organizer can. 0 means a full refund right up to the first game; pass null to use the organization's default (14 days unless the organization changed it). Editable after publish, like every field — an organizer may extend a refund window mid-season, and a registrant is protected by the terms snapshotted onto their registration at hold.
after_full_refund_window	body	string	no	What a registrant gets when they withdraw AFTER the full-refund window closes. Exactly one of: unplayed_share (the share of the season not yet played) or none (no refund). Pass null to use the organization's default. Editable after publish, like every field.
game_gap_minutes	body	integer	no	Minutes between one game ending and the next starting on the same field. Field time for a game is its length plus this; the schedule assumes 15 until set. Pass null to go back to that default. Editable after publish.
playoff_cut	body	string	no	Who reaches the playoffs. Exactly one of: top_4, top_2, all. Unset reads as top_4. Editable after publish.
early_bird_fee_cents	body	integer	no	The early-bird price per player, in cents; must be lower than fee_cents. It applies to divisions that use the program fee, from registration opening until early_bird_weeks later. Pass null to remove it. Editable after publish.
early_bird_weeks	body	integer	no	How many weeks after registration opens the early-bird price lasts (1-52). Pass null to clear.
rsvp_reminders	body	boolean	no	Whether Hollis sends RSVP asks: 96 hours before each published game, then chases at 48 and 24 hours to players who have not answered. On by default; false turns it off for this program. Editable after publish.
payment_reminders	body	boolean	no	Whether Hollis sends payment reminders: weekly to a registrant while their price is above zero and unpaid. On by default; false turns it off for this program. Editable after publish.
waiver_reminders	body	boolean	no	Whether Hollis sends waiver reminders: weekly to a registrant until the waiver is accepted. On by default; false turns it off for this program. Editable after publish.
roster_reminders	body	boolean	no	Whether Hollis sends roster-short reminders: weekly to a captain whose roster is below the minimum, until the season starts. On by default; false turns it off for this program. Editable after publish.
game_reminders	body	boolean	no	Whether Hollis sends a game reminder: an email to every rostered player the day before each published game. On by default; false turns it off for this program. Editable after publish.
sub_fee_cents	body	integer	no	What a substitute pays for one game, in cents, overriding the derived fee (half a player's fee divided by the weeks of play). 0 makes subs free. Pass null to go back to the derived fee. A sub call already made keeps the fee it was made with.
pass_on_processing	body	boolean	no	Whether the payer is charged Stripe's card processing fee as its own checkout line (true), or the organization absorbs it (false). Stripe's full fee on the card total, so the organization receives the price. null = the organization's default. Applies to payments started from then on.
draws_allowed	body	boolean	no	Results: true for wins, draws and losses (3/1/0, the default); false for wins and losses only, which standings show as W / L / Pct. Editable after publish.
questions	body	array of object	no	The questions the program asks, as the WHOLE ordered list (it replaces what is stored; [] asks none). Editable after publish; whoever registers next is asked.
waiver_id	body	integer	no	The id of one of the organization's waivers (list-waivers) that registrants accept. Pass null to use the organization's default waiver. Editable after publish; whoever registers next accepts it.
no_game_days	body	array of object	no	The weeks with no games, as the WHOLE list (it replaces what is stored; pass null or [] to clear). Each date must be a date the program plays on, and each pushes the season end out a week. Editable after publish.
first_game_on	body	string	no	The date of the first game, as YYYY-MM-DD. This is the ANCHOR: changing it RE-DERIVES opens_at and closes_at from the program's stored registration offsets. Editable after publish; a committed schedule that no longer fits is flagged, not moved.
weeks_of_play	body	integer	no	How many weeks of regular season are played. Editable after publish.
playoff_weeks	body	integer	no	How many weeks of playoffs are played; 0 means a playoffs period of no length, which is a different fact from having none.
registration_opens_weeks_before	body	integer	no	How many weeks before the first game registration opens; may be negative. Changing it re-derives opens_at. Editable after publish.
registration_closes_days_before	body	integer	no	How many days before the first game registration closes; may be negative. Changing it re-derives closes_at. Editable after publish.
game_days	body	array of integer	no	The days of the week games are played on, as ISO weekday numbers: 1 is Monday through 7 is Sunday.
game_day_hours	body	object	no	The window games may be played in on each game day, keyed by ISO weekday (1 Monday .. 7 Sunday): {"2": {"from": "18:00", "to": "22:00"}}. Times are HH:MM, to after from. Games go only where these hours overlap field time inside an Approved or Pending permit.
sub_location_ids	body	array of integer	no	The fields the program plays on, by id, as the WHOLE set — it replaces what is stored; [] clears it. Picked from the organization's existing fields; field time is booked when the schedule is generated. Editable after publish.
players_on_field	body	integer	no	How many players each side fields at once: the 7 in "7v7".
roster_min	body	integer	no	The minimum number of players on a team roster.
max_players_per_team	body	integer	no	The maximum roster size; omit for no maximum rather than sending 0.
game_periods	body	integer	no	How many periods a game is played in.
game_period_minutes	body	integer	no	How many minutes each period lasts.
game_break_minutes	body	integer	no	How many minutes of break sit between periods.
men_allowed	body	boolean	no	Whether men may play.
men_min_on_field	body	integer	no	The minimum number of men required on the field; 0 is a requirement of none, which is a different rule from having no requirement.
women_allowed	body	boolean	no	Whether women may play.
women_min_on_field	body	integer	no	The minimum number of women required on the field; 0 is a requirement of none, which is a different rule from having no requirement.

Deletes a program (soft delete — nothing is permanently destroyed by this tool, but no restore surface exists in this phase).

Name	In	Type	Required	Description
program	path	integer	yes

Returns full detail for one program in the connected organization.

Name	In	Type	Required	Description
program	path	integer	yes

Lists every block of location time allocated to a program, across every location in the connected organization.

Name	In	Type	Required	Description
program	path	integer	yes

Archives a program, hiding it from default lists and closing its registration gate.

Name	In	Type	Required	Description
program	path	integer	yes

Marks a published program Complete by hand (complete: true), overriding the status worked out from its games, or clears that mark (complete: false) so the status is worked out again.

Name	In	Type	Required	Description
program	path	integer	yes
complete	body	boolean	yes	true marks it Complete by hand; false clears the mark.

Copies an existing program in the connected organization into a new one, carrying its season shape, divisions structure, fee and roster rules.

Name	In	Type	Required	Description
program	path	integer	yes
name	body	string	no	The name of the new program. Omit to have one composed from the source program's name.
description	body	string	no	A description for the new program. Omit to carry the source program's own description.
first_game_on	body	string	no	The date of the new season's first game, as YYYY-MM-DD. This is the ANCHOR a copy does not carry: registration opens_at and closes_at are DERIVED from it plus the carried registration offsets, never copied from the source season, whose instants are already in the past.
registration_opens_weeks_before	body	integer	no	Overrides how many weeks before the first game registration opens. May be negative. Omit to carry the source program's own offset. Ignored when there is no first_game_on to measure from.
registration_closes_days_before	body	integer	no	Overrides how many days before the first game registration closes. May be negative. Omit to carry the source program's own offset. Ignored when there is no first_game_on to measure from.
parts	body	array of string: "format", "divisions", "game_days", "fees", "questions"	no	Which groups to bring over: any of format, divisions, game_days, fees. Omit to bring all of them. The name, description, weeks of play and registration offsets always come; registrants, teams, games and results never do. Without divisions the copy gets one default division; without fees its divisions carry no price of their own.

Makes a shared discount code for one program (design-v2 D-103), e.g.

Name	In	Type	Required	Description
program	path	integer	yes
code	body	string	yes	3 to 32 letters, digits, dashes or underscores; stored upper-case.
percent_off	body	integer	no	1 to 100. Give this or amount_off_cents, not both.
amount_off_cents	body	integer	no	An amount off in cents. Give this or percent_off, not both.
description	body	string	no	Why it exists, shown on the invoice (e.g. "sibling discount").
max_uses	body	integer	no	How many registrations may use it. Left out: no limit, or 1 when only_for_email is given.
expires_at	body	string	no	ISO 8601; after this it cannot be applied.
first_time_only	body	boolean	no	Only for players who have never held a place in another program of this organization.
once_per_person	body	boolean	no	Each person may use it on one registration only.
only_for_email	body	string	no	Only the person signed in with this email may use it, once unless max_uses says otherwise; leave it out for anyone holding the code.

Lists a program's shared discount codes (design-v2 D-103): each code, what it takes off, how many times it has been used, its cap, expiry and whether it was withdrawn.

Name	In	Type	Required	Description
program	path	integer	yes

Creates a division (age group or skill tier) within a program in the connected organization.

Name	In	Type	Required	Description
program	path	integer	yes
name	body	string	yes	The name of the division to create.
type	body	string	yes	Either "age_group" or "skill_tier".
max_teams	body	integer	no	Maximum number of TEAMS in this division (D-55): a team takes one place however many players it has, and a free agent takes none until placed in a team. Omit or pass null for no maximum.
men_allowed	body	boolean	no	Whether men may play in this division (D-31, D-37). Omit or null to follow the program's rule. A division plays as Coed, Men's or Women's; it must let men, women or both play.
women_allowed	body	boolean	no	Whether women may play in this division. Omit or null to follow the program's rule.
players_on_field	body	integer	no	Players a side in this division (D-31). Omit or null to follow the program.
women_min_on_field	body	integer	no	Women required on field at once in this division. Omit or null to follow the program.
men_min_on_field	body	integer	no	Men required on field at once in this division. Omit or null to follow the program.
roster_min	body	integer	no	Fewest players on a team's roster in this division. Omit or null to follow the program (or players a side + 2 when this division sets its own players a side).
max_players_per_team	body	integer	no	Most players on a team's roster in this division. Omit or null to follow the program.
accepts_teams	body	boolean	no	Whether teams can sign up for this division (D-42). Defaults to true.
accepts_free_agents	body	boolean	no	Whether free agents (individual players with no team) can sign up for this division (D-42). Defaults to true.
opens_at	body	string	no	When registration opens for this division. Omit to fall back to the program's own opens_at. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the start of that day there.
closes_at	body	string	no	When registration closes for this division, and it must fall strictly after opens_at once both are resolved. Omit to fall back to the program's own closes_at. A value without an explicit UTC offset is read as a wall-clock time in the organization's own timezone; a bare YYYY-MM-DD date means the END of that day (23:59:59) there.
sort_order	body	integer	no	Display order among the program's divisions. Defaults to 0.

Lists divisions within a program in the connected organization.

Name	In	Type	Required	Description
program	path	integer	yes

Assigns a referee (role official) or a crew member (role crew) to one or more games of a program, or clears that role when neither user_id nor organization_official_id is given.

Name	In	Type	Required	Description
program	path	integer	yes
game_ids	body	array of integer	yes	The games to staff (1-500), all in this program.
role	body	string	yes	official or crew.
user_id	body	integer	no	The member to assign; they must hold "Can be assigned as referee" (official) or "Can be assigned as crew" (crew).
organization_official_id	body	integer	no	Instead of user_id: the official row of the member to assign. Give neither to clear the role on those games.
confirm_overlap	body	boolean	no	Send true to assign anyway after a validation error said the person already works an overlapping game.

Invites email addresses to register for an invite-only program; each gets an email with their own link, and only invited addresses can register.

Name	In	Type	Required	Description
program	path	integer	yes
emails	body	array of string	yes	Email addresses to invite.
division_id	body	integer	no	Optional. Invite them to join this division of the program as free agents (works on an open program). Without it, the program must be invite only.

Lists who is invited to an invite-only program, and whether each has registered yet.

Name	In	Type	Required	Description
program	path	integer	yes

Writes a message to everyone on a program’s teams: it shows in each player’s Messages under Program and is emailed.

Name	In	Type	Required	Description
program	path	integer	yes
body	body	string	yes	The message, up to 2000 characters.

Saves an existing program's shape as a reusable program template.

Name	In	Type	Required	Description
program	path	integer	yes
name	body	string	no	A name for the new template. Omit to reuse the program's own name.

Publishes a draft program to public or unlisted visibility, opening it up to accept registrations.

Name	In	Type	Required	Description
program	path	integer	yes
visibility	body	string	yes	Either "public" (listed and open to anyone) or "unlisted" (fully live and accepts registration, but omitted from listings — reachable only by direct link).

Enters a persisted team into a program in the connected organization, creating a per-program team instance.

Name	In	Type	Required	Description
program	path	integer	yes
team_id	body	integer	yes	The id of the persisted team to enter.

Lists teams entered into a program in the connected organization.

Name	In	Type	Required	Description
program	path	integer	yes

Brings an archived program back as a draft: nothing is open to players until it is published again.

Name	In	Type	Required	Description
program	path	integer	yes

Sets who can see a program's page: "public" (listed on the organization's page) or "unlisted" (anyone with the link).

Name	In	Type	Required	Description
program	path	integer	yes
visibility	body	string	yes	"public", "unlisted", or "invite_only" (only invited emails may register; invite them with invite-to-program).

Adds a question to the organization's registration library.

Name	In	Type	Required	Description
label	body	string	yes	The question as players read it, unique in the organization.
answer_type	body	string	no	choice (pick one), several (pick several), text, long_text, number, phone, email, yes_no or date.
options	body	array of string	no	Two or more answers to pick from (choice or several only); null otherwise.

Lists the organization's registration question library: id, label, answer_type (choice (pick one), several (pick several), text, long_text, number, phone, email, yes_no or date), options (a choice's or several's answers; null otherwise) and retired (a program can't pick a retired question).

Rewords a library question, changes its answer_type (choice (pick one), several (pick several), text, long_text, number, phone, email, yes_no or date) or its options, or retires it (retired true) or brings it back (false).

Name	In	Type	Required	Description
question	path	integer	yes
label	body	string	no	New wording, unique in the organization.
answer_type	body	string	no	choice (pick one), several (pick several), text, long_text, number, phone, email, yes_no or date. Moving to a type without options (anything but choice or several) drops its options.
options	body	array of string	no	A choice's or several's answers, two or more; null otherwise.
retired	body	boolean	no	true retires it, false brings it back.

Lists registrations in the connected organization, optionally filtered by program_id, division_id, or status.

Name	In	Type	Required	Description
program_id	query	integer	no	Narrow to registrations in this program.
division_id	query	integer	no	Narrow to registrations in this division.
status	query	string	no	Narrow to registrations with this status (pending_waiver, registered, waitlisted, cancelled). Any other value is refused.

Cancels a registration.

Name	In	Type	Required	Description
registration	path	integer	yes

Returns full detail for one registration in the connected organization.

Name	In	Type	Required	Description
registration	path	integer	yes

Accepts the connected user's own waiver for one of their pending registrations, completing it.

Name	In	Type	Required	Description
registration	path	integer	yes
signed_name	body	string	yes	The full name the person types to sign the waiver, stored with the acceptance and printed on its record. Ask the person for it; never fill it in from their account.
answers	body	array of object	no	Your answers to the program's registration questions. Questions you leave out keep your most recent earlier answer.
gender	body	string	no	woman, man, non_binary or prefer_not_to_say. Asked once and kept on your account; needed where the organization asks it and you have none on file.

Changes the connected user's own answers to a program's registration questions, and their gender, on one of their registrations.

Name	In	Type	Required	Description
registration	path	integer	yes
answers	body	array of object	no	Your answers to the program's registration questions. Questions you leave out keep your most recent earlier answer.
gender	body	string	no	woman, man, non_binary or prefer_not_to_say. Asked once and kept on your account; needed where the organization asks it and you have none on file.

Applies a shared discount code to the caller's own unpaid registration (design-v2 D-103), lowering what pay-registration will charge.

Name	In	Type	Required	Description
registration	path	integer	yes
code	body	string	yes	The code, as given by the organizer.

Moves the connected caller's own registration — or, for an organizer, any registration in this organization — to a different division of the SAME program.

Name	In	Type	Required	Description
registration	path	integer	yes
division_id	body	integer	yes	The id of the target division, within the same program as the registration.

Offers a player who is on a team a move to another team of the program, in their division or another.

Name	In	Type	Required	Description
registration	path	integer	yes
program_team_id	body	integer	yes	The team to offer to move them to, in their division or another.

Starts payment for your own registration via a Stripe-hosted Checkout Session.

Name	In	Type	Required	Description
registration	path	integer	yes

Gives an unpaid registration more time to pay: its payment hold runs for the organization's hold length from now.

Name	In	Type	Required	Description
registration	path	integer	yes

Offers a free agent (a registration with no team) a place on a team in their division.

Name	In	Type	Required	Description
registration	path	integer	yes
program_team_id	body	integer	yes	The team to offer them a place on.

Promotes a waitlisted registration into its division.

Name	In	Type	Required	Description
registration	path	integer	yes

Refunds a paid registration: by default a cancelled one for the whole of what is left; or, with kind, a withdrawal refund (the registration ends) or a partial refund.

Name	In	Type	Required	Description
registration	path	integer	yes
kind	body	string: "withdrawal", "partial", "credit"	no	Omit to refund the whole of what is left on a cancelled registration. "withdrawal": the refund terms' amount, and the registration ends. "partial": amount_cents, and the registration stays. "credit": amount_cents given back as credit (one-way, a year) instead of to the card. Whatever part of any refund the payer's credit paid comes back as credit.
amount_cents	body	integer	no	For kind "partial": cents to the card, at most what is left, less any processing charge the payment keeps back on refunds. For kind "credit": cents, at most everything paid less what already came back; credit keeps nothing back.
reason	body	string: "Injury", "Moved away", "Duplicate payment", "Program change", "Game cancelled", "Other"	no	Required with kind.
note	body	string	no	Required when reason is "Other". At most 140 characters; shown on the invoice and in history.

Withdraws the caller from one of their own registrations, up to the full-refund deadline they were shown when they signed up; after it only an organizer can withdraw them.

Name	In	Type	Required	Description
registration	path	integer	yes
refund_to	body	string: "card", "credit"	no	Where what was paid goes: card (back to the card that paid) or credit (credit for a later registration, only when the caller paid it). Required when there is a refund the caller paid; ignored when nothing was paid.

Settles an OPEN dispute to a stated outcome: upheld, rejected or withdrawn.

Name	In	Type	Required	Description
dispute	path	integer	yes
status	body	string	yes	How the dispute resolves: upheld, rejected, withdrawn. `open` is refused — it is where a dispute starts, not somewhere it can be settled to.
outcome	body	string	yes	What was decided, in words a human can read back. A blank or whitespace-only outcome is refused — a dispute that resolves to nothing has not resolved.

Creates a new role in the connected organization from a set of permission atoms.

Name	In	Type	Required	Description
name	body	string	yes	The name of the role to create.
permission_atoms	body	array of string	yes	The permission atoms this role grants. Must be drawn from the organization's known permission vocabulary, and only ones you hold yourself.

Lists the roles of the connected organization, with each role's permission-atom count and how many members hold it.

Replaces an org-defined role's name and permission atoms in the connected organization.

Name	In	Type	Required	Description
role	path	integer	yes
name	body	string	yes	The role's name. Send the existing name unchanged to edit atoms only.
permission_atoms	body	array of string	yes	The COMPLETE set of permission atoms this role grants after the change. Anything omitted is removed. Must be drawn from the organization's known permission vocabulary.

Deletes an org-defined role in the connected organization.

Name	In	Type	Required	Description
role	path	integer	yes

Lists every program-team instance with a roster in the connected organization.

Lists every fixture in the connected organization, ordered by date then round.