Developers # MCP reference Connect an assistant to Hollis. It gets the tools a person has, and the same approvals. ## Overview Hollis runs a [Model Context Protocol](https://modelcontextprotocol.io) server. Connect it to your assistant and the assistant can read and change your organization with the same roles and approvals you have. It has 241 tools; 71 of them only read. This page is generated from the server, so the list is the one your assistant sees. ## Connect | Setting | Value | |---|---| | Server URL | https://hollisapp.com/mcp/hollis | | Transport | Streamable HTTP | | Auth | OAuth 2.1 with PKCE, with dynamic client registration | | Protocol version | 2026-07-28 | | Server | hollis 0.0.1 | Sign in with OAuth only. An API token from the Tokens page works on the [REST API](https://hollisapp.com/docs/api), not here: sent to the server URL, it gets 401. The server speaks protocol revision 2026-07-28 and no other. A client built for an earlier revision opens with initialize, which that revision removed, and cannot connect until it is updated. The server says so instead of failing quietly: a call with no sign-in gets 401 whose body lists the revision as supported\_protocol\_versions; once signed in, initialize gets 404 and a request naming another revision gets 400, and both answers list the revision in error.data.supported. tools/list answers 15 tools a page. While the result carries a nextCursor, send it back as cursor for the next page. Most clients do this for you. ## Client setup ### Claude Settings, Connectors, Add custom connector. Paste the server URL and sign in to Hollis when asked. ### Claude Code ``` claude mcp add --transport http hollis https://hollisapp.com/mcp/hollis ``` ### Cursor Add this to ~/.cursor/mcp.json, or to a project's .cursor/mcp.json, and sign in to Hollis when Cursor asks. ``` { "mcpServers": { "hollis": { "url": "https://hollisapp.com/mcp/hollis" } } } ``` ### Other clients ``` { "mcpServers": { "hollis": { "url": "https://hollisapp.com/mcp/hollis" } } } ``` Any client that speaks streamable HTTP, OAuth and the protocol revision above can connect the same way. ## Authorization Connecting opens a Hollis page where you sign in, pick which of your organizations the assistant works in, and choose what it may do. A connection acts as you, in that one organization. | Access | What it allows | |---|---| | Read only | The 71 tools that only read. The others are not offered to the assistant at all. | | Read and change | Every tool your role allows. Some still wait for a person, see Approvals. | Read and change is selected unless you pick Read only. A connection's access token lasts 30 days and the assistant renews it with its refresh token, which lapses after 90 days unused; then connect again. To change the organization or the access, connect again; the new choice replaces the old one. ## Approvals Tools marked "approval" never finish on the assistant's word alone. The first call previews what would happen and changes nothing. Depending on the action and your organization's settings, the request then waits on the Approvals page until a person signed in to Hollis approves it, and only then can the assistant complete it. Tools marked "confirm" ask the assistant to call again with the confirmation token from the preview. Nothing else in Hollis can approve a request: there is deliberately no tool for it. ## Tools 241 tools in 35 groups. Each takes JSON arguments; the fields are listed with each tool. ## Allocation - CHANGE - allocate-location-time Allocates a block of a location's permitted time to a program, in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location to allocate time on. | | permit\_id | integer | yes | The id of the permit covering this block, either directly on the location or on one of its fields. | | program\_id | integer | yes | The id of the program this time is allocated to. | | date | string | yes | The date this block occurs on (date string). | | start\_time | string | yes | The block start time, in H:i (24-hour) format. | | end\_time | string | yes | The block end time, in H:i (24-hour) format, strictly after start\_time. | | cost\_cents | integer | yes | The cost of this block, in integer cents. | | held\_for\_makeup | boolean | no | Whether this block is being held in reserve for a makeup game. | - CHANGE - delete-allocation Removes an allocated block of location time from the organization. Destroys data: the first call previews what would happen, including how many scheduled games would lose their allocated location, and writes nothing; call again with the returned confirmation\_token to actually remove it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | allocation\_id | integer | yes | The id of the allocation block to remove. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - list-location-allocations Lists every block of time allocated on one location in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location whose allocated blocks to list. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-program-inventory Lists every block of location time allocated to a program, across every location in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program whose allocated inventory to list. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - update-allocation Corrects an existing allocation block's time window or its cost, in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | allocation\_id | integer | yes | The id of the allocation block to correct. | | start\_time | 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 | 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 | 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. | ## Area - CHANGE - assign-location-area Hand-assigns a location to an area, or clears its assignment. Never derived from the location's geo. Calls the same underlying write path as PATCH /api/locations/{location}. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location to assign. | | area\_id | integer \| null | no | The id of the area to assign the location to. Pass null to clear the location's area assignment; omit this field entirely to leave the current assignment unchanged. | - CHANGE - create-area Creates an area (up to two levels, org-defined labels) in the connected organization. Never derived from a location's geo — hand-created only. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the area to create. | | label | string | yes | The organization's own name for this level, e.g. 'Borough'. | | level | integer | yes | 1 or 2. A level-2 area must name a level-1 parent\_area\_id. | | parent\_area\_id | integer | no | Required when level is 2; must not be supplied when level is 1. | - CHANGE - delete-area Deletes an area from the organization. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually delete it. Refused if the area still has a child area or an assigned location. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | area\_id | integer | yes | The id of the area to delete. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - get-area Returns full detail for one area, including its immediate children and assigned locations, in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | area\_id | integer | yes | The id of the area to retrieve. | - READ - list-areas Lists areas in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - update-area Renames an area, changes its label, or moves a second-level area under another top-level area. Only the fields supplied are changed. An area's level is permanent; a top-level area has no parent. | Field | Type | Required | Description | |---|---|---|---| | area\_id | integer | yes | The id of the area to update. | | name | string | no | The new name of the area. | | label | string | no | The new label of the area. | | parent\_area\_id | 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. | ## Area alert - CHANGE - subscribe-to-updates 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. Sends one confirmation email; nothing else is sent until the address's owner confirms. The answer is the same whether or not the address was already subscribed. | Field | Type | Required | Description | |---|---|---|---| | email | string | yes | The address to email. Its owner must confirm before anything but the confirmation is sent. | | area\_id | 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. | ## Billing - CHANGE - connect-payments Starts connecting the organization's own Stripe account so it can take payments. Returns a Stripe link for the organizer to open in a browser; Stripe asks them to create an account or sign in. Nothing is charged. Call it again once they have finished: payments\_connected is Stripe's answer at that moment. - CHANGE - disconnect-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). New payments stop until connect-payments is called again, which then creates a new account. Past payments, refunds and payouts stay with the old account. The first call previews, with how many payments the account took and how many checkouts are open on it; call again with the returned confirmation\_token to disconnect. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | ## Blackout - CHANGE - create-blackout Records a blackout (date + reason) on a field, in the connected organization. Draft games already on that field and date move to Held; committed games stay where they are and are listed in the result. | Field | Type | Required | Description | |---|---|---|---| | sub\_location\_id | integer | yes | The id of the field. | | date | string | yes | The blacked-out date. | | reason | string | yes | Why this date is blacked out. | - READ - list-blackouts Lists blackouts recorded for a field, in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | sub\_location\_id | integer | yes | The id of the field. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | ## Contact - CHANGE - add-contact Adds a contact by email to a contact list in the connected organization. Idempotent — adding an already-present email changes nothing. | Field | Type | Required | Description | |---|---|---|---| | contact\_list\_id | integer | yes | The id of the contact list to add the contact to. | | email | string | yes | The contact's email address. | | contact\_name | string | no | The contact's display name, if known. | - CHANGE - create-contact-list Creates a named contact list in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the new contact list. | - CHANGE - delete-contact-list Deletes a contact list and its memberships. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually delete it. Contact records and suppression (unsubscribe/bounce) state are unaffected, and there is no undo. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | contact\_list\_id | integer | yes | The id of the contact list to delete. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - get-contact-list Returns one contact list in the connected organization, including its contacts. | Field | Type | Required | Description | |---|---|---|---| | contact\_list\_id | integer | yes | The id of the contact list to retrieve. | - CHANGE - import-contacts Imports contacts into a contact list from an existing source (division registrants, a team roster, or organization members). This is a one-time snapshot — the list does not stay in sync with the source afterward. | Field | Type | Required | Description | |---|---|---|---| | contact\_list\_id | integer | yes | The id of the contact list to import into. | | source | string | yes | The source to import from: division\_registrants, program\_team\_roster, or organization\_members. | | source\_id | integer | yes | The id of the division, program-team instance, or 0 for organization\_members (which has no source id). | - READ - list-announcement-opt-outs 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. The "opted out" count on a new announcement counts these. Needs the right to send announcements. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-announcements Lists the announcements the connected organization has sent, each with when it went out, how many it was enqueued to, and how many contacts were suppressed. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-contact-lists Lists the connected organization's contact lists, each with its member count. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - remove-contact Removes a contact from one contact list. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually remove it. The contact is NOT unsubscribed and stays on any other list — this only removes one list membership. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | contact\_list\_id | integer | yes | The id of the contact list to remove the contact from. | | contact\_id | integer | yes | The id of the contact to remove. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - resend-announcement-to-contact Sends one already-sent announcement to ONE of its recipients again — the retry for a soft bounce such as a full mailbox. Sends real mail, which cannot be unsent: the first call previews what would happen and sends nothing; call again with the returned confirmation\_token to actually send. Refuses outright for a hard-bounced, complained-about or unsubscribed address, naming which. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | announcement\_id | integer | yes | The id of the announcement to send again. | | recipient\_id | integer | yes | The id of the recipient row on that announcement to send to. One recipient only. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - send-announcement 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. Replies go to the organization's announcements address, not to Messages. A real, external, hard-to-fully-undo mail delivery under the organization's own sending domain — there is no unsend. This action destroys nothing directly but cannot be reversed once sent: it takes effect only after a human signed in to Hollis has reviewed and approved it, and cannot be redeemed a second time for a different message or a different list. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | to | 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 | integer | no | The id of the program, division or contact list. Not used for the organization. | | contact\_list\_id | integer | no | The id of the contact list to send to — the same as to=list with this id. | | subject | string | yes | The email subject line. | | body | string | yes | The message body, written as Markdown — \*\*bold\*\*, \_italic\_, and \[links\](url) are supported. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - stop-announcements-to-person 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. Every announcement audience leaves them out from then on, and the "opted out" count includes them. Only the person can turn announcements back on: an organizer cannot undo this, and there is no tool to. Idempotent; an address that already stopped, for any reason, is left exactly as it was. Needs the right to send announcements. | Field | Type | Required | Description | |---|---|---|---| | email | string | yes | The person's address: a contact or a member of this organization. | | note | string | no | Why, in your words — "asked by phone". Up to 255 characters; kept with the stop. | - CHANGE - update-contact-email Corrects one contact's email address on a contact list. Overwrites the stored address: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually change it. IMPORTANT to relay: bounce and complaint suppressions are recorded against an ADDRESS, so changing it stops this contact being suppressed and mail will be sent to them again. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | contact\_list\_id | integer | yes | The id of the contact list the contact is on. | | contact\_id | integer | yes | The id of the contact whose address is being corrected. | | email | string | yes | The corrected email address. Stored lowercased. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | ## Credit - READ - get-member-credit 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). Read only: credit cannot be voided or paid out as cash, and only the holder can give it to someone else. Needs payments.view. | Field | Type | Required | Description | |---|---|---|---| | member\_id | integer | yes | The id of the member whose credit to read. | - READ - my-credit Returns the caller's own credit balance with this organization and each unexpired part of it with its expiry date. Credit comes off the next registration the caller pays for; it cannot be turned into cash, except a captain's credit from free agents placed on a team they paid for in full (withdraw-credit), and can be given to another person in the organization with transfer-credit. held\_cents is that captain credit still held until its season ends: not in the balance, and neither spent nor withdrawn before then. - CHANGE - transfer-credit Gives part or all of the caller's own credit with this organization to another member of it. The credit keeps its expiry dates and cannot come back unless they give it back. The first call previews what would happen and writes nothing; repeat it with the confirmation\_token it returns. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | to\_user\_id | integer | yes | The id of the member of this organization to give the credit to. | | amount\_cents | integer | yes | How much, in cents; at most the caller's balance. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - withdraw-credit 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. That credit is held until the season ends and cannot be withdrawn before. registration\_id is the caller's own registration on that team; amount\_cents defaults to all of it. Other credit cannot be withdrawn. The first call previews what would happen and writes nothing; repeat it with the confirmation\_token it returns. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The caller's own registration on the team they paid for in full. | | amount\_cents | integer | no | How much, in cents; at most the credit and what the card paid. Left out: all of it. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | ## Discount - CHANGE - apply-discount-code Applies a shared discount code to the caller's own unpaid registration (design-v2 D-103), lowering what pay-registration will charge. One code per registration; a second replaces the first. An open checkout for it is closed first. | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The caller's own registration. | | code | string | yes | The code, as given by the organizer. | - CHANGE - create-discount-code Makes a shared discount code for one program (design-v2 D-103), e.g. SIBLING10: a percentage OR an amount off, with an optional cap on uses and an expiry, and optionally for first-time players only, once per person, or for one person only (only\_for\_email: anyone else is told the code is not valid, as for an unknown code; such a code is used once unless max\_uses says otherwise). A code always covers the whole program, never one division. Payers apply it to their own unpaid registration before paying. Anyone holding the code can use it, so give it a cap or an expiry when it should not spread. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The program the code is for. | | code | string | yes | 3 to 32 letters, digits, dashes or underscores; stored upper-case. | | percent\_off | integer | no | 1 to 100. Give this or amount\_off\_cents, not both. | | amount\_off\_cents | integer | no | An amount off in cents. Give this or percent\_off, not both. | | description | string | no | Why it exists, shown on the invoice (e.g. "sibling discount"). | | max\_uses | integer | no | How many registrations may use it. Left out: no limit, or 1 when only\_for\_email is given. | | expires\_at | string | no | ISO 8601; after this it cannot be applied. | | first\_time\_only | boolean | no | Only for players who have never held a place in another program of this organization. | | once\_per\_person | boolean | no | Each person may use it on one registration only. | | only\_for\_email | 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. | - READ - list-discount-codes 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. Needs the right to edit the program. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The program whose codes to list. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - restore-discount-code Brings back a withdrawn shared discount code, so payers can apply it again under its own limits. Its uses so far still count against its cap. | Field | Type | Required | Description | |---|---|---|---| | discount\_code\_id | integer | yes | The withdrawn code to bring back (from list-discount-codes). | - CHANGE - revoke-discount-code Withdraws a shared discount code (design-v2 D-103). Nobody can apply it again; registrations that already used it keep their price. | Field | Type | Required | Description | |---|---|---|---| | discount\_code\_id | integer | yes | The code to withdraw (from list-discount-codes). | ## Division - CHANGE - create-division Creates a division (age group or skill tier) within a program in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program to add this division to. | | name | string | yes | The name of the division to create. | | type | string | yes | Either "age\_group" or "skill\_tier". | | max\_teams | 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 | 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 | boolean | no | Whether women may play in this division. Omit or null to follow the program's rule. | | players\_on\_field | integer | no | Players a side in this division (D-31). Omit or null to follow the program. | | women\_min\_on\_field | integer | no | Women required on field at once in this division. Omit or null to follow the program. | | men\_min\_on\_field | integer | no | Men required on field at once in this division. Omit or null to follow the program. | | roster\_min | 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 | integer | no | Most players on a team's roster in this division. Omit or null to follow the program. | | accepts\_teams | boolean | no | Whether teams can sign up for this division (D-42). Defaults to true. | | accepts\_free\_agents | boolean | no | Whether free agents (individual players with no team) can sign up for this division (D-42). Defaults to true. | | opens\_at | 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 | 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 | integer | no | Display order among the program's divisions. Defaults to 0. | - CHANGE - delete-division Removes a division from a program. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually remove it. The removal is a soft delete — nothing is permanently destroyed by this tool. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division to remove. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - get-division Returns full detail for one division in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division to retrieve. | - READ - list-division-seeds Lists a division's seed proposal: the order its teams would be paired in. Each position is marked "stored" (a saved seeding) or "default" (the fall-back order the division has when nothing has been saved). A position with no team is a HELD (deliberately empty) position and comes back with a null program\_team\_id. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division whose seed proposal to read. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-divisions Lists divisions within a program in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program whose divisions to list. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - save-division-seeds Replaces a division's ENTIRE seed order in one call. `seeds` is the whole ordered list, position 1 first: send every position you want the division to have, not just the ones you are changing. A null program\_team\_id is a HELD (deliberately empty) position; to release a held position, leave it out of the next call; to reset the division to its default order, send an empty list. Teams entered in the division that the list does not name keep their default order after the ones it does. Every id is re-checked against the teams actually entered in this division, and a team entered in a different division is refused. This overwrites any order saved by someone else since you read it. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division whose seed order to replace. | | seeds | 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. | - CHANGE - update-division Updates a division's name, type, maximum number of teams, gender, who can sign up, sort order, or window override. Only the fields supplied are changed; omitted fields are left as they are. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division to update. | | name | string | no | The new name of the division. | | type | string | no | Either "age\_group" or "skill\_tier". | | max\_teams | 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 | 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 | boolean | no | Whether women may play in this division. Omit or null to follow the program's rule. | | players\_on\_field | integer | no | Players a side in this division (D-31). Omit or null to follow the program. | | women\_min\_on\_field | integer | no | Women required on field at once in this division. Omit or null to follow the program. | | men\_min\_on\_field | integer | no | Men required on field at once in this division. Omit or null to follow the program. | | roster\_min | 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 | integer | no | Most players on a team's roster in this division. Omit or null to follow the program. | | accepts\_teams | boolean | no | Whether teams can sign up for this division (D-42). Defaults to true. | | accepts\_free\_agents | boolean | no | Whether free agents (individual players with no team) can sign up for this division (D-42). Defaults to true. | | opens\_at | 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 | 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 | integer | no | Display order among the program's divisions. | | fee\_cents | 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. | ## Export - READ - export-data 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. Format csv, xlsx (Excel), json or pdf (up to 2,000 rows). The file holds the rows the matching screen lists for the same filters, and needs the permission to view that screen; every export is recorded in the access log. Give the person the link; do not read the file out. | Field | Type | Required | Description | |---|---|---|---| | dataset | string: "members", "teams", "rosters", "registrations", "schedule", "standings", "payments" | yes | Which table: members (Members), teams (Teams), rosters (Rosters), registrations (Registrations), schedule (Schedule), standings (Standings), payments (Payments). | | format | string: "csv", "xlsx", "json", "pdf" | no | csv (default), xlsx for Excel, json, or pdf (at most 2,000 rows). | | q | string | no | Search text, as the table's search box (members, teams, rosters, payments). | | program\_id | integer | no | Only this program. Required for standings. | | division\_id | integer | no | Only this division (registrations, standings). | | location\_id | integer | no | Only games at this location (schedule). | | status | 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 | string | no | Payments: All, Payments, Refunds or Charges. | | when | string | no | Payments: All time, Last 7 days, Last 30 days or Last 90 days. Schedule: all, upcoming, staff or held. | | role | string | no | Members: only people holding this role. | | program | string | no | Members: only people in the program of this name. | | history | string | no | Members: anyone, returning, first or idle. | | owes | string | no | Members: unpaid, waiver, unregistered or noteam. | | show | string | no | Teams and rosters: current (teams in a program now, the default) or all. | | view | string | no | Standings: official (default) or live. | | sort | string | no | Sort column key, as the table's own sort (e.g. name, date, amt). | | dir | string | no | asc or desc. | ## Field - CHANGE - create-sub-location Creates a field under a location in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location to add this field to. | | name | string | yes | The name of the field to create. | - READ - get-sub-location-availability Computes a field's available windows (union of permits minus blackouts) across a date range, in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | sub\_location\_id | integer | yes | The id of the field. | | from | string | yes | The start of the date range (date string). | | to | string | yes | The end of the date range (date string), strictly after from and within one year of it. | - READ - list-sub-locations Lists a location's fields, in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location whose fields to list. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - remove-sub-location Removes a field from a location. The first call previews and writes nothing; call again with the returned confirmation\_token to remove it. Refused while games are still to be played there: move them first. Games already played keep it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | sub\_location\_id | integer | yes | The id of the field to remove. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - update-sub-location Renames a field of a location in the connected organization. Two fields of one location cannot share a name. | Field | Type | Required | Description | |---|---|---|---| | sub\_location\_id | integer | yes | The id of the field to rename. | | name | string | yes | The field's new name. | ## Game staff - CHANGE - assign-game-staff 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 the person by user\_id or by organization\_official\_id, not both. The person must hold the organization's "Can be assigned as referee" or "Can be assigned as crew" permission for the role. Someone already assigned to that role on a game is released. Published games email the person once with every game; draft games wait until they are published. A person who already works a game that overlaps one of these (45 minutes between different locations) is named in a validation error and nothing is assigned until you send the same call again with confirm\_overlap true. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The program the games belong to. | | game\_ids | array of integer | yes | The games to staff (1-500), all in this program. | | role | string | yes | official or crew. | | user\_id | 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 | 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 | boolean | no | Send true to assign anyway after a validation error said the person already works an overlapping game. | - CHANGE - reply-to-game-assignment Accepts or declines a game you were assigned to as an official or crew member, or undoes your decline. answer is accept, decline or undo. Only the assigned person can answer; declining frees the game for someone else (a game you already accepted can be given back until 6 hours before it starts; add an optional reason only the organizer reads), accepting a game that overlaps one you already accepted is refused with a warning until you send the same call again with confirm\_overlap true; and undo puts it back to waiting for your answer while nobody else has been assigned. | Field | Type | Required | Description | |---|---|---|---| | assignment\_id | integer | yes | The assignment to answer. | | answer | string | yes | accept, decline or undo (a decline, while nobody else has been assigned). | | reason | string | no | Optional, with a decline: why you cannot make it. Only the organization reads it. 500 characters at most. | | confirm\_overlap | boolean | no | Send true to accept anyway after a validation error said the game overlaps one you already accepted. | - CHANGE - set-game-assignment-position 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. The position must be on the same side as the place: a Referee-side position for the referee, a Crew-side one for crew. Positions are listed by list-official-fees. Requires permission to assign referees and crew. | Field | Type | Required | Description | |---|---|---|---| | assignment\_id | integer | yes | The assignment: one person’s place on one game. | | position\_id | integer | yes | The position, from list-official-fees. | ## General - READ - who-am-i Returns the connected user's identity and the bounds of their own access: their acting organization, their role, the scope and expiry of each grant they hold, and the atoms they can actually reach, in sentences. ## Import - CHANGE - commit-staged-import Writes a reviewed staged import into a contact list, one contact per row. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually import. It writes CONTACTS ONLY — a column read as the paid/unpaid state is read and staged; no payment is written, and no registration is created. Rows with no email address are skipped and recorded as skipped. An import can only be committed once. Ask the person, in their own words, what they told these people their email is for and where the list came from, and ask them to confirm each of the three statements; never answer these for them. A commit without all five is refused. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | staged\_import\_id | integer | yes | The id returned by stage-import. Review its rows and column mapping before calling this. | | contact\_list\_id | integer | yes | The id of the contact list to write the contacts into. There is no default — a roster written into a list nobody named is not a choice anyone made. | | purpose | string | yes | What the person told these people their email is for, in the person's words (for example "league news and schedules"). Ask them; never write it for them. Kept with the import and shown in Settings › Import. | | list\_source | string | yes | Where the list came from, in the person's words (for example "our spring sign-up sheet"). Ask them. | | confirms\_not\_bought | boolean | yes | true only when the person confirms, themselves: "No address on this list was bought, rented or scraped." | | confirms\_relationship | boolean | yes | true only when the person confirms, themselves: "Everyone on it already has a relationship with {the organization's name}." | | confirms\_sender | boolean | yes | true only when the person confirms, themselves: "I take responsibility for emailing them, as the sender." | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - stage-import Stages a pasted roster or contact list for review in the connected organization. Nothing is imported by this call: it reads the text into rows and a proposed column mapping you can inspect and change, and writes no contacts. Accepted text is a CSV-like block with a header line, or a plain list of email addresses. There is no file upload on this surface — paste the file contents as text; an .xlsx sheet must be saved as .csv first. Call commit-staged-import to actually write the contacts. | Field | Type | Required | Description | |---|---|---|---| | payload | string | yes | The rows to stage, as text: a CSV-like block whose first line names the columns, or a plain list of email addresses with no header at all. Paste the contents of a file rather than the file — this surface has no upload. | | source\_kind | string | no | How the text arrived: "csv" when it is the contents of a .csv file, "paste" when it was typed or copied from somewhere else. It is a label on the record only — the same text is read the same way either way. Defaults to "paste". | | program\_id | integer | no | Optional id of the program this import belongs to. A staged import needs no program; omit it when the roster is not for one in particular. | - CHANGE - update-staged-import-mapping Changes what one column of a staged import reads as — both retargeting a column Hollis already placed and promoting one it left out. Writes no contacts and never rewrites the staged rows: the mapping is an interpretation laid over the data, so it can be changed as often as you like. Refused once the import has been committed, because its mapping is then the record of how those contacts were read. | Field | Type | Required | Description | |---|---|---|---| | staged\_import\_id | integer | yes | The id returned by stage-import. | | column | string | yes | The column to retarget, spelled exactly as it appears in the staged import's detected\_headers. | | field | string | yes | What this column should read as. One of: name, email, phone, team, payment\_state, not\_imported. These are READ AND STAGED BUT NEVER WRITTEN: team, payment\_state — the value is kept on the staged row and the commit writes neither, so mapping a column to one of them records what the file said without acting on it. A column left as not\_imported is left out rather than guessed at; it stays visible and can be promoted later with this same call. | ## Location - CHANGE - add-location-custom-field Adds a custom field (name and value) to a location. Set secret to true for a value that must be masked and revealed only through a logged reveal, like a gate code. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location. | | name | string | yes | The field name, e.g. "Gate code". Up to 100 characters. | | value | string | no | The value. Up to 1000 characters. | | secret | boolean | no | Mask the value and log every reveal. | - CHANGE - create-location Creates a location (address, geo, and public detail) in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the location to create. | | address | string | no | The location's street address. Optional: omit it if it is not known yet. | | latitude | number | no | Latitude, between -90 and 90. Omit if unknown. | | longitude | number | no | Longitude, between -180 and 180. Omit if unknown. | | has\_parking | boolean | no | Whether the location has parking. Defaults to false. | | has\_lights | boolean | no | Whether the location has lights for night play. Defaults to false. | | is\_indoor | boolean | no | Whether the location is indoor. Defaults to false. | | surface | string | no | The playing surface (e.g. "grass", "turf"). Omit if unknown. | | area\_id | 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. | - READ - get-location Returns full detail for one location, including its fields, in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location to retrieve. | - READ - list-location-custom-fields Lists a location's custom fields (name and value). A secret field shows no value, and no tool reveals it: a person reveals it in Hollis, where the reveal is logged. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location. | - READ - list-locations Lists locations in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - remove-location-custom-field Removes a custom field from a location. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually remove it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | field\_id | integer | yes | The id of the custom field to remove. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - set-location-access-block 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. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location whose access block to set. | | permit\_or\_booking\_reference | string | no | The permit or booking reference for this location. Omit to leave unset. | | site\_contact | string | no | The site or city contact for this location. Omit to leave unset. | | after\_hours\_number | string | no | An after-hours contact number for this location. Omit to leave unset. | | gate\_code | string | no | The gate access code for this location. Omit to leave unset. | | light\_panel\_code | string | no | The light-panel access code for this location. Omit to leave unset. | | keyholder | string | no | The name of the person who holds keys for this location. Omit to leave unset. | - CHANGE - update-location Changes a location's name, address, indoor/outdoor type, surface or area in the connected organization. Only the fields given change. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | yes | The id of the location to change. | | name | string | no | The location's new name. Omit to keep it. | | address | string | no | The location's street address. Omit to keep it; pass an empty string to clear it. | | is\_indoor | boolean | no | Whether the location is indoor. Omit to keep it. | | surface | string | no | The playing surface (e.g. "grass", "turf"). Omit to keep it; pass an empty string to clear it. | | area\_id | integer | no | The id of the area to assign the location to. Omit to keep it. | - CHANGE - update-location-custom-field Changes a location custom field's name, value or secret flag. Only the keys you pass change. | Field | Type | Required | Description | |---|---|---|---| | field\_id | integer | yes | The id of the custom field. | | name | string | no | A new name. | | value | string | no | A new value. | | secret | boolean | no | Mask the value and log every reveal, or stop doing so. | ## Message - CHANGE - hide-message Hides a player’s or captain’s message written to the organizers (from organizer-messages), or shows it again with hidden false. Hidden, it is gone from everyone’s Messages but its writer’s, who sees “Removed by the organizer”; emails already sent stay sent. Needs the right to send announcements. | Field | Type | Required | Description | |---|---|---|---| | message\_id | integer | yes | The message to hide or show. | | hidden | boolean | no | true (default) hides it; false shows it again. | - READ - my-messages Lists YOUR OWN messages in this organization, newest first: what your teams, their captains and the organizers wrote to you, and what you wrote. Each says who it went to, its conversation’s topic, whether it is new, and whether you can reply. - READ - organizer-messages 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. Needs the right to send announcements. | Field | Type | Required | Description | |---|---|---|---| | box | string | no | inbox (default) or sent. Any other value is refused. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - reply-to-message Answers a message from my-messages. The reply reaches the same people as the message it answers, except an answer to an organizer’s message sent to many, which goes to the organizers only as its own conversation; an answer to an organizer’s message to one person stays in that conversation. Only someone the message was for, or who wrote it, can reply. | Field | Type | Required | Description | |---|---|---|---| | message\_id | integer | yes | The message to answer. | | body | string | yes | The reply, up to 2000 characters. | - CHANGE - send-organizer-message 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). Or pass targets — a list of {to, id} — for one message to several at once; each person is emailed once. It shows in their Messages and is emailed. Needs the right to send announcements; a person or the organization needs it org-wide. Recipients may answer, and an answer goes to the organizers only; to one person alone, their answer stays in the same conversation. For a whole program use send-program-message. | Field | Type | Required | Description | |---|---|---|---| | to | string | no | team, division, game, person or organization. Omit when sending targets. | | id | 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 | array of object | no | Several recipients for one message, up to 50. Use instead of to and id. | | body | string | yes | The message, up to 2000 characters. | - CHANGE - send-program-message Writes a message to everyone on a program’s teams: it shows in each player’s Messages under Program and is emailed. Needs the right to send announcements. Recipients may answer, and an answer goes to the organizers only. A program of more than 50 people asks for a confirmation first. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The program whose teams receive it. | | body | string | yes | The message, up to 2000 characters. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - send-team-message Writes a message for one of YOUR teams. audience is team (everyone on it), captains (its captain), player (one player: captains only, with recipient\_user\_id) or organizers (the organization’s organizers; share=true lets the rest of the team see it). It shows on Home and is emailed. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | One of your teams. | | audience | string | yes | team, captains, player or organizers. | | body | string | yes | The message, up to 2000 characters. | | recipient\_user\_id | integer | no | For audience player: the player on your team. | | share | boolean | no | For audience organizers: let the rest of the team see it. | ## Official - CHANGE - add-my-away-window Records an absolute away window — a start date and an end date — for the connected user, for dates they will be unavailable to officiate. Both bounds are required and the end may not precede the start; a single-day window is allowed. This is for an absolute absence such as being out of the country, never for a standing preference. Refuses if the connected user is not an official here. | Field | Type | Required | Description | |---|---|---|---| | starts\_on | 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 | 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 | 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. | - CHANGE - add-official-position Adds a position for referees and crew, such as Line judge, on the Referee side or the Crew side. The side decides who may hold it: people who can be assigned as referee, or as crew. Refuses a name already in use. Requires the Pay referees and crew permission. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The position, at most 60 characters. | | side | string: "official", "crew" | yes | official for the Referee side, crew for the Crew side. | - CHANGE - connect-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. Returns a Stripe link for them to open in a browser. Only for referees and crew of this organization; moves no money. - READ - get-official-agreement Reads the organization’s agreement for referees and crew: whether officials are asked to sign it (asks), whether they must sign before accepting a game (sign\_first), the current version and its text, and each referee or crew member with the version they signed, if any. Requires permission to change the organization’s settings. - READ - list-official-fees Lists the organization’s positions for referees and crew and the fee per game for each: the organization default per position, each program’s own fee, and each game that has its own fee, and each game that pays a percentage above or below (percents). A game’s fee is its own, else its program’s, else the default, moved by the game’s percentage unless it is the game’s own; a changed fee applies to every game not yet paid. Requires the Pay referees and crew permission. - READ - list-official-pay Lists what each referee and crew member is owed, game by game: the game, its date, the position they held and its current fee, for games they accepted and worked. Requires the Pay referees and crew permission. - READ - my-bank-account Shows the connected user’s own bank account for getting paid as a referee or crew member: whether it is connected, and the bank’s name and last four digits. Only their own. - READ - my-coverage Lists the areas the connected user has declared they will officiate in, for this organization. Refuses if the connected user is not an official here. - READ - my-pay Lists the connected user’s own fees as a referee or crew member, game by game: the game, its date, the position they held, the fee and whether it is owed. Only their own; nobody else’s pay. - CHANGE - pay-officials Pays referees and crew what they are owed for games they worked: one debit from the organization’s bank account for the total plus Stripe’s fee, and each official’s share deposited once the debit clears (a few business days). Pass the official\_id of each official to pay (from list-official-pay). Only games with a fee and officials with a bank account connected are paid. Requires the Pay referees and crew permission, and a human signed in to Hollis must approve it first: the first call returns an approval reference and URL; call again with approval\_reference after a human has approved. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | official\_ids | array of integer | yes | The official\_id of each official to pay, from list-official-pay. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - remove-my-away-window Removes one of the connected user's own absolute away windows, by its id. Refuses if the window belongs to another official, if it does not exist, or if the connected user is not an official here. Use my-coverage or add-my-away-window to see the current windows and their ids. | Field | Type | Required | Description | |---|---|---|---| | away\_window\_id | integer | yes | The id of the away window to remove. It must belong to the connected user; any other id is refused rather than ignored. | - CHANGE - remove-official-position Removes a position for referees and crew. People who held it keep their games and their fee. Refuses the last position on the Referee side or the Crew side. Requires the Pay referees and crew permission. | Field | Type | Required | Description | |---|---|---|---| | position\_id | integer | yes | The position, from list-official-fees. | - CHANGE - set-game-fee-percent 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. The percentage moves the program’s fee for the position, else its default; a fee set for that one game with set-official-fee is a price and is not moved. percent null (or 0) clears it. -100 to 500. A new percentage applies to every game not yet paid, and every referee or crew member with an unpaid place on the game whose fee changes is emailed the old and new amount a few minutes later (edits made close together are one email); notified\_officials says how many. A game already paid keeps what it paid. Requires the Pay referees and crew permission. | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The game, from list-games. | | percent | integer \| null | yes | Whole percent above (+) or below (-) the usual fee, -100 to 500; null or 0 clears it. | - CHANGE - set-my-coverage Declares which areas the connected user will officiate in, replacing their current declaration. Pass an empty list to declare that they will work nowhere. Refuses if the connected user is not an official here, or if an area belongs to another organization. | Field | Type | Required | Description | |---|---|---|---| | area\_ids | 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. | - CHANGE - set-official-fee 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). fee\_cents null clears it, so a program or game falls back to the level above. A new fee applies to every game not yet paid. Requires the Pay referees and crew permission. | Field | Type | Required | Description | |---|---|---|---| | position\_id | integer | yes | The position, from list-official-fees. | | program\_id | integer | no | Set this program’s own fee. Omit for the organization default. | | game\_id | integer | no | Set one game’s own fee. Never with program\_id. | | fee\_cents | integer \| null | yes | The fee per game in cents, 0 to 1000000; null clears it. | - CHANGE - update-official-agreement Changes the organization’s agreement for referees and crew. body: the organization’s own text; a changed text saves a new version, and everyone who signed an earlier version is asked to sign again. asks: whether officials are asked to sign it. sign\_first: whether an official must sign the current version before accepting a game (off by default; needs asks on and a saved version). Send only what changes. Hollis supplies no wording. Requires permission to change the organization’s settings. | Field | Type | Required | Description | |---|---|---|---| | body | string | no | The agreement’s full text, in the organization’s own words. A change saves a new version. | | asks | boolean | no | Ask officials to sign the agreement. | | sign\_first | boolean | no | An official must sign the current version before accepting a game. | ## Organization - CHANGE - cancel-invitation Cancels an invitation to join the organization that has not been accepted; its link stops working. The first call previews and writes nothing; call again with the returned confirmation\_token to cancel. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | invitation\_id | integer | yes | The id of the invitation, as list-invitations returns it. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - change-member-role Changes a member's role within the connected organization. `user\_id` must be the exact numeric id of an existing member and `role\_name` must be an exact, existing role name — never resolve an ambiguous or free-text reference (a person's name, or a role name you are inferring or inventing) yourself; if either is ambiguous, call `list-members` to confirm the member and ask the user for the exact role name. This action can remove authority as easily as grant it and takes effect only after a human signed in to Hollis has reviewed and approved it. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | user\_id | integer | yes | The member's user id. | | role\_name | string | yes | The role to assign. | | scope\_type | 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 | 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 | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - create-custom-role Creates a new role in the connected organization from a set of permission atoms. The role grants nothing until it is assigned to a member. A role with only player, captain, guardian, referee or crew permissions is one call; a role with any organizer permission needs a confirmation and then a human signed in to Hollis to approve it. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the role to create. | | permission\_atoms | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - create-organization Creates a new organization owned by the connected user. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the organization to create. | | timezone | 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. | - CHANGE - delete-custom-role Deletes an org-defined role in the connected organization. A role that somebody currently holds is REFUSED, naming how many people hold it — reassign them first. Built-in roles cannot be deleted. `role\_id` must be the exact numeric id of an existing role; call `list-roles` to confirm it rather than inferring one. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | role\_id | integer | yes | The exact numeric id of the role to delete. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - get-mail-domain Reads the connected organization's sending identity: hostname, verification status, and (while pending) the DNS records still to add. Returns a null mail\_domain if nothing has been provisioned yet, which is a normal state, not an error. - CHANGE - invite-member Invites a user to join the connected organization under a named role. Inviting someone to a player, captain, guardian, referee or crew role is one call. A role with organizer access (admin, staff, or a custom role with any organizer permission) needs a confirmation and then a human signed in to Hollis to approve it before the invitation is sent. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | email | string | yes | The email address to invite. | | role\_name | string | yes | The role to assign the invitee. | | name | 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 | 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 | 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 | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - READ - list-invitations Lists pending invitations for the connected organization: invitee, role, scope and when the grant ends. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-members Lists members of the connected organization. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-roles Lists the roles of the connected organization, with each role's permission-atom count and how many members hold it. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - provision-mail-domain Provisions the connected organization's default sending subdomain, or (with custom\_hostname) upgrades to a custom domain. Idempotent: re-running with no custom\_hostname when a domain already exists is a no-op. | Field | Type | Required | Description | |---|---|---|---| | custom\_hostname | 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. | - CHANGE - revoke-member Revokes a member's access to the connected organization. `user\_id` must be the exact numeric id of an existing member — never resolve an ambiguous or free-text reference (a name, an initial, "the new player") to a person yourself; if the reference is ambiguous, call `list-members` first and ask the user which member they mean. This action destroys data: it takes effect only after a human signed in to Hollis has reviewed and approved it, and cannot be undone by calling this tool again. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | user\_id | integer | yes | The member's user id. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - update-custom-role Replaces an org-defined role's name and permission atoms in the connected organization. `permission\_atoms` REPLACES the role's whole set — atoms you omit are removed from the role, and every member holding it loses them immediately. Send the complete intended set, not a delta; call `list-roles` first if you are unsure what the role carries. Built-in roles cannot be changed — copy one instead with `create-custom-role`. Every change needs a confirmation; a role that carries organizer permissions after the change also needs a human signed in to Hollis to approve it. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | role\_id | integer | yes | The exact numeric id of the role to change. | | name | string | yes | The role's name. Send the existing name unchanged to edit atoms only. | | permission\_atoms | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - update-organization-mail-settings Updates the bound organization's mail settings. Sets the physical postal address that United States CAN-SPAM law requires in every bulk announcement footer, and the address announcements are sent as on the organization's own domain. | Field | Type | Required | Description | |---|---|---|---| | postal\_address | 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 | 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. | - CHANGE - update-organization-payment-settings 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). Only the fields supplied are changed; omitted fields are left as they are. | Field | Type | Required | Description | |---|---|---|---| | refund\_requires\_approval | 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 | integer | no | How many minutes an unpaid registration holds its slot before the hold lapses. Must be at least 1. | | refund\_keeps\_fees | 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 | 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 | 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 | 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. | - CHANGE - update-organization-profile 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). Send only the fields to change. | Field | Type | Required | Description | |---|---|---|---| | name | string | no | At most 60 characters. | | slug | string | no | Lowercase letters, numbers and hyphens, 3–30 characters. | | timezone | string | no | An IANA time zone, e.g. America/New\_York. | | sports | array of string | no | From: Soccer, Basketball, Volleyball, Softball, Hockey, Pickleball, Tennis, Flag football, Ultimate, Kickball, Other. | | multi\_sport | boolean | no | true for several sports; false (the default) for exactly one. | - CHANGE - update-organization-registration-settings 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). Every organization takes players 18 and over only for now (adults\_only, returned; it cannot be changed yet). | Field | Type | Required | Description | |---|---|---|---| | asks\_gender | boolean | no | true asks players their gender once and keeps it; false never collects it. | | subs\_multiple\_teams | 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. | - CHANGE - verify-mail-domain 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. ## Payment - CHANGE - cancel-charge Cancels an unpaid charge in the connected organization: its payment link stops working. The first call previews; call again with the returned confirmation\_token to cancel. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | payment\_id | integer | yes | The charge to cancel. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - create-charge Asks a member of the connected organization to pay an amount for something outside registration: emails them a payment link. The first call previews and writes nothing; call again with the returned confirmation\_token to send it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | payer\_user\_id | integer | yes | Who pays: a member of this organization. | | description | string | yes | What it is for, as the payer will read it (80 characters at most). | | amount\_cents | integer | yes | The amount, in cents (50 to 200000). | | program\_id | integer | no | Optional: the program it is for. | | program\_team\_id | integer | no | Optional: the program team it is for (implies its program). | | due\_on | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - list-payments 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. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - pay-charge Starts payment of a charge the connected organization asked you to pay, via a Stripe-hosted Checkout Session. The first call previews; call again with the returned confirmation\_token to get the checkout link. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | payment\_id | integer | yes | The charge you were asked to pay. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - pay-registration Starts payment for your own registration via a Stripe-hosted Checkout Session. The first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually start the checkout. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of the registration to pay for. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - pay-team-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. The first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually start the checkout. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance whose payable registrations should be paid. | | division\_id | integer | yes | The id of the division these registrations belong to. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - refund-registration 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. A real, external, hard-to-fully-undo financial transfer. Depending on this organization's settings, this either requires a single confirmation or a second human's approval before it happens. The first call moves no money: it returns a confirmation\_token to repeat the call with, or opens an approval request (approval\_reference) that a person must approve on the web before a repeat call refunds. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of the registration to refund. | | kind | 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 | 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 | string: "Injury", "Moved away", "Duplicate payment", "Program change", "Game cancelled", "Other" | no | Required with kind. | | note | string | no | Required when reason is "Other". At most 140 characters; shown on the invoice and in history. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - resend-charge-link Emails an unpaid charge's payment link to its payer again. The first call previews; call again with the returned confirmation\_token to send. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | payment\_id | integer | yes | The unpaid charge whose link to send. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | ## Permit - CHANGE - create-permit Creates a permit naming exactly one of a location or a field it covers, in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | no | The id of the location this permit is for. Provide location\_id or sub\_location\_id, not both. | | sub\_location\_ids | array of integer | no | With location\_id: the ids of the location's fields this permit covers. Omit for the whole location. | | sub\_location\_id | integer | no | Shorthand for a permit covering just this one field, at its location. Provide location\_id or sub\_location\_id, not both. | | valid\_from | string | yes | The date this permit becomes valid (date string). | | valid\_to | string | yes | The date this permit expires, strictly after valid\_from. | | days | 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 | string | yes | The daily start time, in H:i (24-hour) format. | | end\_time | string | yes | The daily end time, in H:i (24-hour) format, strictly after start\_time. | | reference\_number | string | yes | The permit or booking reference number. | | status | 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. | - READ - get-permit Returns full detail for one permit in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | permit\_id | integer | yes | The id of the permit to retrieve. | - READ - list-permit-change-events Lists a permit's change events (edits that narrowed a previously-granted window), in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | permit\_id | integer | yes | The id of the permit. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-permits Lists permits in the connected organization, soonest to expire first. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - update-permit 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. | Field | Type | Required | Description | |---|---|---|---| | sub\_location\_ids | 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. | | permit\_id | integer | yes | The id of the permit to update. | | valid\_to | string | no | The new expiry date (date string), strictly after valid\_from. | | days | 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 | string | no | The new daily start time, in H:i (24-hour) format. | | end\_time | string | no | The new daily end time, in H:i (24-hour) format, strictly after start\_time. | | status | 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. | ## Playoffs - READ - get-playoff-seeds Reads a division's playoff seeds: the official standings order within the playoff cut, the seeds (that order unless an organizer reordered it), who changed what, and whether the playoffs have started. Program team ids, first seed first. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division whose playoff seeds to read. | - CHANGE - move-playoff-seed Moves a team up or down one playoff seed in its division (swapping with its neighbour). Recorded with who made it. Refused once the playoffs have started. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division. | | program\_team\_id | integer | yes | The team to move, as get-playoff-seeds names it. | | direction | string: "up", "down" | yes | up: one seed better; down: one seed worse. | - CHANGE - reset-playoff-seeds Puts a division's playoff seeds back in the official standings order. Recorded with who made it. Refused once the playoffs have started. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division. | - CHANGE - start-playoffs 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. Needs the schedule published. Asks for confirmation first. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division whose playoffs to start. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | ## Program - CHANGE - archive-program Archives a program, hiding it from default lists and closing its registration gate. Destroys nothing (unarchive-program brings it back, as a draft) but is treated as destructive: the first call previews what would happen and writes nothing. If the program has divisions, this action also requires a human signed in to Hollis to review and approve it before it takes effect — call again with the returned confirmation\_token, then again with the approval\_reference that call returns, once a human has approved the request on the web. A program with no divisions only needs the confirmation step. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program to archive. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - copy-program Copies an existing program in the connected organization into a new one, carrying its season shape, divisions structure, fee and roster rules. The copy is ALWAYS created as a DRAFT, whatever the source program's visibility was — publish it separately once it is ready. Registrants, teams, schedules and results are never copied. | Field | Type | Required | Description | |---|---|---|---| | source\_program\_id | integer | yes | The id of the program to copy. It must belong to the connected organization. | | name | string | no | The name of the new program. Omit to have one composed from the source program's name. | | description | string | no | A description for the new program. Omit to carry the source program's own description. | | first\_game\_on | 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 | 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 | 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 | 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. | - CHANGE - create-program Creates a new program (season) in the connected organization, starting in draft visibility. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the program to create. | | description | string | no | An optional description of the program. | | opens\_at | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | integer | no | How many players each side fields at once: the 7 in "7v7". | | roster\_min | integer | no | The minimum number of players on a team roster. Defaults to players\_on\_field plus two when omitted. | | max\_players\_per\_team | integer | no | The maximum roster size. Omit for no maximum; do not send 0 to mean that. | | max\_teams | 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 | integer | no | How many periods a game is played in. | | game\_period\_minutes | integer | no | How many minutes each period lasts. | | game\_break\_minutes | integer | no | How many minutes of break sit between periods. | | men\_allowed | boolean | no | Whether men may play. Defaults to true. | | men\_min\_on\_field | 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 | boolean | no | Whether women may play. Defaults to true. | | women\_min\_on\_field | 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. | - CHANGE - create-program-from-template Creates a new program from a program template in the connected organization. The template is COPIED, never linked: the new program keeps no reference to it, and editing either one afterwards does not affect the other. Any field you send overrides the template's value for that field. | Field | Type | Required | Description | |---|---|---|---| | program\_template\_id | integer | yes | The id of the template to create this program from. | | name | 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 | string | no | An optional description of the program. A template carries none — it is prose about one season. | | first\_game\_on | 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 | 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 | 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 | 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 | integer | no | The registration fee in CENTS, not in currency units. Omit to keep the template's fee. | | weeks\_of\_play | integer | no | Overrides the template's weeks of regular season. | | playoff\_weeks | integer | no | Overrides the template's weeks of playoffs. | | registration\_opens\_weeks\_before | 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 | 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 | integer | no | Overrides how many players each side fields at once: the 7 in "7v7". | | roster\_min | integer | no | Overrides the minimum number of players on a team roster. | | max\_players\_per\_team | integer | no | Overrides the maximum roster size. | | max\_teams | 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 | integer | no | Overrides how many periods a game is played in. | | game\_period\_minutes | integer | no | Overrides how many minutes each period lasts. | | game\_break\_minutes | integer | no | Overrides how many minutes of break sit between periods. | | men\_allowed | boolean | no | Overrides whether men may play. | | men\_min\_on\_field | 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 | boolean | no | Overrides whether women may play. | | women\_min\_on\_field | 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. | - CHANGE - delete-program Deletes a program (soft delete — nothing is permanently destroyed by this tool, but no restore surface exists in this phase). The first call previews what would happen and writes nothing. If the program has divisions, this action also requires a human signed in to Hollis to review and approve it before it takes effect — call again with the returned confirmation\_token, then again with the approval\_reference that call returns, once a human has approved the request on the web. A program with no divisions only needs the confirmation step. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program to delete. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - READ - get-program Returns full detail for one program in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program to retrieve. | - CHANGE - invite-to-program Invites email addresses to register for an invite-only program; each gets an email with their own link, and only invited addresses can register. Already-invited addresses are skipped. The program must be invite only (set-program-visibility with invite\_only), unless division\_id is given: then each address is invited to join that division as a free agent, on an open or invite-only published program alike. Nobody is registered by being invited: they open the link, sign in and register themselves, and the division's capacity of teams never refuses a number of people. With division\_id, addresses already registered in the program, already invited, unsubscribed or undeliverable are skipped, each reported with its reason. Up to 200 at a time; more than 50 asks for a confirmation first, and an organization sends at most 500 emails an hour and 2000 a day across invitations and messages. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The invite-only program. | | emails | array of string | yes | Email addresses to invite. | | division\_id | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - list-program-invitations Lists who is invited to an invite-only program, and whether each has registered yet. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The invite-only program. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-programs Lists programs in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | | archived | boolean | no | true lists the archived programs instead of the others, so one can be brought back with unarchive-program. | - CHANGE - mark-program-complete 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. Not for drafts or archived programs. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program. | | complete | boolean | yes | true marks it Complete by hand; false clears the mark. | - CHANGE - publish-program Publishes a draft program to public or unlisted visibility, opening it up to accept registrations. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program to publish. | | visibility | 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). | - CHANGE - remove-program-invitation Removes an invited email from an invite-only program: their link stops working and they can no longer register. Someone already registered cannot be removed this way. | Field | Type | Required | Description | |---|---|---|---| | program\_invitation\_id | integer | yes | The invitation to remove. | - CHANGE - set-program-visibility Sets who can see a program's page: "public" (listed on the organization's page) or "unlisted" (anyone with the link). On a draft it sets what the program will be published as; on a published program it changes it at once. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program. | | visibility | string | yes | "public", "unlisted", or "invite\_only" (only invited emails may register; invite them with invite-to-program). | - CHANGE - unarchive-program Brings an archived program back as a draft: nothing is open to players until it is published again. Registrations, teams, games and staff are untouched. Refused for a program that is not archived. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the archived program. | - CHANGE - update-program Updates a program's name, description, registration window or season shape, or flips its early-close switch. Only the fields supplied are changed; omitted fields are left as they are. Every field stays editable after publish. When a change leaves committed games that no longer fit (a game on a day, hour or field the program no longer plays, or outside its dates), nothing is refused and no game moves: the program is flagged and a task asks for the schedule to be regenerated. On a program with one game day, moving first\_game\_on to another weekday moves the game day with it. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program to update. | | name | string | no | The new name of the program. | | description | string | no | The new description of the program. | | opens\_at | 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 | 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 | 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 | integer | no | Registration fee in cents. Omit to leave unchanged; pass null to clear the fee. | | full\_refund\_days\_before\_first\_game | 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 | 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 | 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 | 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 | 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 | integer | no | How many weeks after registration opens the early-bird price lasts (1-52). Pass null to clear. | | rsvp\_reminders | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | integer | no | How many weeks of regular season are played. Editable after publish. | | playoff\_weeks | 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 | 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 | 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 | 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 | 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 | 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 | integer | no | How many players each side fields at once: the 7 in "7v7". | | roster\_min | integer | no | The minimum number of players on a team roster. | | max\_players\_per\_team | integer | no | The maximum roster size; omit for no maximum rather than sending 0. | | game\_periods | integer | no | How many periods a game is played in. | | game\_period\_minutes | integer | no | How many minutes each period lasts. | | game\_break\_minutes | integer | no | How many minutes of break sit between periods. | | men\_allowed | boolean | no | Whether men may play. | | men\_min\_on\_field | 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 | boolean | no | Whether women may play. | | women\_min\_on\_field | 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. | ## Program team - CHANGE - add-team 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. The team shows as awaiting captain until they do. Never discloses the invitation link. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division to add the team to. | | name | string | no | The new team's name. Required unless team\_id is given. | | captain\_email | 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 | 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 | string: "division", "waitlist" | no | "division" takes one of its spots (refused when full); "waitlist" joins its wait list. Defaults to division. | - CHANGE - assign-captain Assigns or clears the captain of a per-program team instance in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the per-program team instance to assign a captain for. | | captain\_user\_id | integer | no | The id of the organization member to make captain. Omit this field entirely to clear the current captaincy. | - CHANGE - assign-co-captain Names or clears the co-captain of a per-program team instance: a second full captain (roster, payment, results) for that one team. Exactly one per team; naming another replaces the current one. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the per-program team instance. | | co\_captain\_user\_id | integer | no | The id of the organization member to make co-captain. Omit this field entirely to clear the co-captaincy. | - CHANGE - choose-team-payment Chooses who pays for one team's entry. captain\_pays true: the captain pays for the whole team (the division's roster minimum times the per-player price), which covers that many places, the captain's included; players who join after those pay their own share; a free agent placed on the team pays as usual and that money becomes the captain's credit, held until the season ends. false: each player pays their share (the default). Only the team's captain or co-captain, or someone who manages its roster, and only before anyone on the team has paid. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The per-program team instance. | | captain\_pays | boolean | yes | true: the captain pays for the whole team; false: each player pays their share. | - CHANGE - create-team-from-free-agents 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. Nobody is put on the roster by this call. Refused, with nothing sent, when the selection misses the division's roster minimum or maximum or a gender minimum. Never discloses a link. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division the free agents are registered in; the team is added to it. | | name | string | yes | The new team's name. | | registration\_ids | array of integer | yes | The selected free agents' registrations, captain included. | | captain\_registration\_id | integer | no | One of registration\_ids, to invite as captain. Give this or captain\_email. | | captain\_email | string | no | Someone else to invite as captain, when none of the free agents is. Give this or captain\_registration\_id. | - CHANGE - enter-program Enters a persisted team into a program in the connected organization, creating a per-program team instance. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program to enter the team into. | | team\_id | integer | yes | The id of the persisted team to enter. | - READ - get-program-team Returns full detail for one per-program team instance in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the per-program team instance to retrieve. | - READ - list-program-teams Lists teams entered into a program in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program whose entered teams to list. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - my-teams Lists the teams the connected user is on in this organization, and flags which ones they captain. Use this first to find a program\_team\_id for roster tools. | Field | Type | Required | Description | |---|---|---|---| | captain\_only | boolean | no | When true, returns only the teams the connected user captains. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - remove-program-team Removes a team's per-program instance from a program. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually remove it. The removal is a soft delete of the instance and a hard delete of its roster entries — the underlying team and program rows are untouched. Registrations on the team with nothing paid, signed or not, are cancelled; each paid player becomes a task to refund or credit them (no money moves here; to settle one now, call refund-registration for their registration, under its own approval). Games not yet played keep their slot with a stand-in side, "Pending Team #N"; games already played keep the team's name and score. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance to remove. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - resend-captain-invitation 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). Never discloses the link. | Field | Type | Required | Description | |---|---|---|---| | captain\_invitation\_id | integer | yes | The captain invitation to re-send. | | captain\_email | string | no | Optional. Invite this address instead (design-v2 D-117). Required when the invited captain declined. | - CHANGE - resign-captaincy Resigns the caller's own captaincy (or co-captaincy) of a per-program team instance; they stay on the roster as a player. A captain with a co-captain hands over to them at once; a captain with none stays captain until the organizer names a new one, and the organizer is given a task. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the per-program team instance whose captaincy the caller resigns. | ## Program template - CHANGE - create-program-template Creates a reusable program template in the connected organization. A template holds a program's SHAPE only — no dates, no season, no people — and is copied into a new program at create time, never linked to one. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the template to create, as an organizer would recognise it — for example "7v7 Coed". | | players\_on\_field | integer | no | How many players each side fields at once: the 7 in "7v7". | | max\_teams | 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 | 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 | integer | no | The maximum roster size. Omit for no maximum; do not send 0 to mean that. | | game\_periods | integer | no | How many periods a game is played in. | | game\_period\_minutes | integer | no | How many minutes each period lasts. | | game\_break\_minutes | integer | no | How many minutes of break sit between periods. | | men\_allowed | boolean | no | Whether men may play. Defaults to true. | | men\_min\_on\_field | 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 | boolean | no | Whether women may play. Defaults to true. | | women\_min\_on\_field | 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 | integer | no | The registration fee in CENTS, not in currency units — 5000 is fifty dollars. | | registration\_opens\_weeks\_before | 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 | 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 | integer | no | How many weeks of regular season are played. | | playoff\_weeks | 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 | 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. | - CHANGE - delete-program-template Removes a program template from the connected organization. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually remove it. Programs already created from the template are NOT affected in any way — a program is a copy, never a link. The removal is a soft delete. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | program\_template\_id | integer | yes | The id of the program template to remove. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - list-program-templates Lists the reusable program templates in the connected organization, optionally filtered by format, gender or length. | Field | Type | Required | Description | |---|---|---|---| | format | integer | no | Keep only templates whose players\_on\_field equals this exactly — the 7 in "7v7". Omit for any format. | | gender | string | no | One of "coed", "mens" or "womens". Reads the two allowed-to-play booleans; omit for any gender. | | length | integer | no | Keep only templates whose weeks\_of\_play equals this exactly. Omit for any length. | | sort | 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. | - CHANGE - save-program-as-template Saves an existing program's shape as a reusable program template. Carries the game shape, gender rules, fee, team maximum and relative registration offsets — never the dates, the registration window, the visibility, or anyone registered. The program itself is unchanged and is not linked to the template afterwards. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | yes | The id of the program whose shape to save. | | name | string | no | A name for the new template. Omit to reuse the program's own name. | - CHANGE - update-program-template Edits an existing program template in the connected organization. Only the fields you send are changed; everything else is left exactly as it was. | Field | Type | Required | Description | |---|---|---|---| | program\_template\_id | integer | yes | The id of the program template to edit. | | name | 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 | integer | no | How many players each side fields at once: the 7 in "7v7". | | max\_teams | 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 | 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 | integer | no | The maximum roster size. Omit for no maximum; do not send 0 to mean that. | | game\_periods | integer | no | How many periods a game is played in. | | game\_period\_minutes | integer | no | How many minutes each period lasts. | | game\_break\_minutes | integer | no | How many minutes of break sit between periods. | | men\_allowed | boolean | no | Whether men may play. Defaults to true. | | men\_min\_on\_field | 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 | boolean | no | Whether women may play. Defaults to true. | | women\_min\_on\_field | 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 | integer | no | The registration fee in CENTS, not in currency units — 5000 is fifty dollars. | | registration\_opens\_weeks\_before | 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 | 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 | integer | no | How many weeks of regular season are played. | | playoff\_weeks | 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 | 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. | ## Registration - CHANGE - accept-waiver Accepts the connected user's own waiver for one of their pending registrations, completing it. The first call previews the waiver text and writes nothing; call again with the returned confirmation\_token to actually accept it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of your own pending registration to accept the waiver for. | | signed\_name | 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 | array of object | no | Your answers to the program's registration questions. Questions you leave out keep your most recent earlier answer. | | gender | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - cancel-registration Cancels a registration. Destroys nothing irreversibly (the row remains as a historical record): the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually cancel it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of the registration to cancel. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - extend-payment-hold Gives an unpaid registration more time to pay: its payment hold runs for the organization's hold length from now. A lapsed hold keeps its spot until an organizer extends it or releases the spot with cancel-registration. | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of the registration whose payment hold to extend. | - READ - get-registration Returns full detail for one registration in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of the registration to retrieve. | - READ - list-free-agents 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. A player's email is included only if you can view members. Use offer-placement to place one on a team. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division whose free agents to list. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-registrations Lists registrations in the connected organization, optionally filtered by program\_id, division\_id, or status. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | no | Narrow to registrations in this program. | | division\_id | integer | no | Narrow to registrations in this division. | | status | string | no | Narrow to registrations with this status (pending\_waiver, registered, waitlisted, cancelled). Any other value is refused. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - move-registration Moves the connected caller's own registration — or, for an organizer, any registration in this organization — to a different division of the SAME program. Does not require confirmation: it changes an existing row's division, never creating or cancelling one. | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of the registration to move — your own, or any you hold registrations.manage for. | | division\_id | integer | yes | The id of the target division, within the same program as the registration. | - CHANGE - move-team-registrations Moves every active registration on a program-team instance's roster to a different division of the SAME program, in one call. Does not require confirmation: it changes existing rows' division, never creating or cancelling one. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance whose roster registrations should be moved. | | division\_id | integer | yes | The id of the target division, within the same program as the roster's registrations. | - CHANGE - move-team-to-waitlist Moves a team off its spot in a division and back onto that division's wait list, freeing the spot. Anyone on the team who has paid is refunded what is left of their payment in the same act. Refused once the season has started. The first call moves nothing: it returns a confirmation\_token, or, when it refunds and the organization requires approval for refunds, opens an approval request (approval\_reference) that a second person must approve on the web before a repeat call goes ahead. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The team (program team id) to move. | | division\_id | integer | yes | The division whose spot it gives up. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - READ - my-placement-offers 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. Where a place has a price, accepting it means paying it by that same time (expires\_at): there is one deadline to accept and pay. A move to a team in another division carries price\_difference\_cents, what accepting changes in your price (positive costs more, negative costs less and is given as credit if you have paid, 0 nothing); null on a place offered to a free agent. - READ - my-registrations Lists the registrations belonging to the connected user in this organization. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - offer-placement Offers a free agent (a registration with no team) a place on a team in their division. The player is emailed and has 24 hours to accept or decline; nothing changes on the roster until they accept. Never discloses the offer link. | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The free agent's registration. | | program\_team\_id | integer | yes | The team to offer them a place on. | - CHANGE - offer-team-move Offers a player who is on a team a move to another team of the program, in their division or another. The player is emailed and has 24 hours to accept or decline; they stay on their current team until they accept, and accepting moves them in one step. A move to a team in another division can change what they owe, and the offer states the amount before they accept (price\_difference\_cents: positive costs more, negative costs less, 0 nothing; it also says source\_team\_left\_empty: true when nobody else would stay on the team they leave, the move still going through): an unpaid place is re-priced and paid the usual way, a paid place that costs more is charged the difference with a pay link, and either way the player has seven days from accepting to pay, while one that costs less is given the difference as credit, never to the card. A move to or from a team that pays its whole entry is refused, as is moving a captain or co-captain. Never discloses the offer link. | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The registration of the player who is on a team. | | program\_team\_id | integer | yes | The team to offer to move them to, in their division or another. | - CHANGE - promote-registration Promotes a waitlisted registration into its division. Destroys nothing: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually promote it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of the registration to promote. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - register-for-division Registers the connected user for a division in the connected organization, accepting the current waiver. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division to register for. | | waiver\_accepted | boolean | yes | Must be true — confirms the connected user accepts the organization's current waiver. | | signed\_name | 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 | integer | no | Optional. Joins this existing team instance of the same program. Mutually exclusive with team\_name. | | team\_name | 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 | 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 | 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 | array of string | no | Optional, with bring\_back\_program\_team\_id. New email addresses to invite to the team. | | answers | array of object | no | Your answers to the program's registration questions. Questions you leave out keep your most recent earlier answer. | | gender | 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. | - CHANGE - register-team Registers every player on a program-team instance's roster into a division of the connected organization. Each player enters a pending-waiver state and must accept their own waiver individually (see accept-waiver) before their registration is confirmed. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance whose roster should be registered. | | division\_id | integer | yes | The id of the division to register the roster into. | - CHANGE - respond-to-placement-offer Accepts or declines one of YOUR OWN placement offers (see my-placement-offers). Accepting puts you on the team's roster; where the place has a price, you pay it by the offer's own expiry (pay\_by), the same deadline you had to accept, and the place is held for you until then. Declining keeps you in the free-agent pool, and that team cannot offer again this program. | Field | Type | Required | Description | |---|---|---|---| | placement\_offer\_id | integer | yes | The offer to answer. | | answer | string: "accept", "decline" | yes | accept or decline. | - CHANGE - update-my-registration-answers Changes the connected user's own answers to a program's registration questions, and their gender, on one of their registrations. | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The id of one of your own registrations (my-registrations). | | answers | array of object | no | Your answers to the program's registration questions. Questions you leave out keep your most recent earlier answer. | | gender | 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. | - CHANGE - withdraw-my-registration 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. What was paid is refunded in full: refund\_to card sends it back to the card that paid, less the processing charge where the league keeps it on refunds; credit gives all of it as credit for a later registration, nothing kept back (only when the caller paid it themselves). A place someone else covered, or one not paid yet, is released and nothing is refunded. The first call previews what would happen and writes nothing; repeat it with the confirmation\_token it returns. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | registration\_id | integer | yes | The caller's own registration. | | refund\_to | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | ## Registration question - CHANGE - create-registration-question Adds a question to the organization's registration library. answer\_type is choice (pick one), several (pick several), text, long\_text, number, phone, email, yes\_no or date; choice and several take two or more options, the others none. Left out, options make it a choice and no options make it text. A program then asks it through update-program's `questions`. | Field | Type | Required | Description | |---|---|---|---| | label | string | yes | The question as players read it, unique in the organization. | | answer\_type | string | no | choice (pick one), several (pick several), text, long\_text, number, phone, email, yes\_no or date. | | options | array of string | no | Two or more answers to pick from (choice or several only); null otherwise. | - READ - list-registration-questions 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). A program asks some of them — set with update-program's `questions`. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - update-registration-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). Every program asking it asks the new wording from the next registration; earlier answers keep pre-filling because the question keeps its identity. A retired question cannot be picked by a program; programs already asking it keep asking it. Position and Skill level are always choice. | Field | Type | Required | Description | |---|---|---|---| | question\_id | integer | yes | The id of the library question (list-registration-questions). | | label | string | no | New wording, unique in the organization. | | answer\_type | 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 | array of string | no | A choice's or several's answers, two or more; null otherwise. | | retired | boolean | no | true retires it, false brings it back. | ## Roster - CHANGE - add-roster-player Adds a player to one program-team instance's roster in the connected organization. The player must already be a member of this organization. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance to add the player to. | | user\_id | integer | yes | The id of the user to add. Must already be a member of this organization. | - CHANGE - bring-back-players 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. Pass user\_ids from list-bring-back-players, or none to invite everyone offered. Captain only. Never discloses the invitation links. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the team you captain, as entered in this program. | | user\_ids | 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. | - CHANGE - cancel-team-invitation Takes back an invitation to a program-team instance's roster that nobody has accepted; its link stops working. The first call previews and writes nothing; call again with the returned confirmation\_token to cancel. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance the invitation is to. | | invitation\_id | integer | yes | The id of the team invitation to take back (from invite-to-team). | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - invite-to-team Issues a team invitation to one program-team instance's roster in the connected organization. Never discloses the invitation link. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance to invite to. | | email | string | yes | The email address to invite. | | name | 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). | - READ - list-bring-back-players 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. Each row carries the user\_id bring-back-players takes. Captain only; empty when nobody is left to offer. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the team you captain, as entered in this program. | - READ - list-candidate-members 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. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance to list candidate members for. | | players\_only | 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. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-organization-rosters Lists every program-team instance with a roster in the connected organization. An atom holder (rosters.view) sees every instance; an attached-only caller (captain or rostered player) sees only the instance(s) they are attached to. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-roster Lists the players on one program-team instance's roster in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance whose roster to list. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-team-invitations 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. Optionally narrow by status. Each row carries the invitation\_id cancel-team-invitation takes. | Field | Type | Required | Description | |---|---|---|---| | program\_id | integer | no | List the invitations of every team you may manage in this program. | | program\_team\_id | integer | no | List the invitations of this one team instance. Wins over program\_id. | | status | string | no | Narrow to one status: pending, accepted, cancelled, expired. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - put-back-roster-player 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). Refused while the player is on another of the program's teams. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance the player was removed from. | | user\_id | integer | yes | The id of the removed player. | - CHANGE - remove-roster-player Removes a player from a program-team instance's roster. Their registration on that team is cancelled with it when nothing is paid, signed or not; a paid registration, or one with a checkout in progress, is left for the organizer. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually remove the player. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The id of the program-team instance to remove the player from. | | user\_id | integer | yes | The id of the user to remove from the roster. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | ## Rsvp - CHANGE - answer-rsvp Says whether you are playing a game: answer is yes or no, with an optional reason on a no. Only a player on one of the game’s two rosters can answer, only for themselves, and only before kickoff. Answers can be changed. No answer counts as not playing. | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The game. | | answer | string | yes | yes or no. | | reason | string | no | Optional, on a no: why (up to 120 characters). | - READ - list-game-rsvps Lists who is playing a game: per team, how many said yes, no, or have not answered (which counts as no), whether the team is at forfeit risk, and each player’s answer and check-in. You see only the teams whose roster you may read. | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The game. | - CHANGE - remind-rsvp Emails the RSVP ask again to players on one team of a game who have not answered. Without user\_ids, everyone on the team who has not answered is asked. Needs the team’s captain or permission to manage rosters. | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The game. | | program\_team\_id | integer | yes | Which of the two teams. | | user\_ids | array of integer | no | Optional: only these players (each must be on the team and not have answered). | ## Schedule - CHANGE - commit-schedule Promotes a division's draft games to committed, making the schedule visible to players and ready to distribute. The first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually commit it. You can still edit, add, or remove individual games afterward. Refused while the program is still draft: publish the program first. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division whose draft schedule to commit. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - create-game Adds one game to a division's schedule. Both teams must already be entered in that division. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division to add this game to. | | round\_number | integer | yes | Which round of the schedule this game belongs to. | | scheduled\_at | 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 | integer | yes | The id of the home team's entry in this program. Must already be entered in this division. | | away\_program\_team\_id | 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 | 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 | integer | no | How long this game runs, in minutes. Required if sub\_location\_id is set. | - CHANGE - decide-makeup 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. Depending on this organization's settings it needs a single confirmation or a second person's approval; the first call changes nothing: it returns a confirmation\_token, or opens an approval request (approval\_reference) that a person must approve on the web before a repeat call goes ahead. A refund cannot be decided here: a person decides it on the Schedule tab, or you use refund-registration per player. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division the cancelled game belongs to. | | game\_id | integer | yes | The id of the cancelled game in the make-up queue. | | decision | string: "credit" | yes | credit — each paid player's share of the fee, as credit. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - delete-game Removes a game from a division's schedule. A published game is cancelled with a reason (Location, Team, Officials, Weather, or Other with a note) and goes to the make-up queue; make it up with schedule-makeup. Destroys nothing outside Hollis: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually remove it. Cancelling a game is recoverable by adding it back — it is a status flip, not a permanent delete. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division this game belongs to. | | game\_id | integer | yes | The id of the game to remove. | | reason | string: "Location", "Team", "Officials", "Weather", "Other" | no | For a published game: why it is cancelled. It goes to the make-up queue. | | note | string | no | What happened, up to 140 characters; required when the reason is Other. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - distribute-schedule Distributes a division's committed schedule by emailing it to every non-suppressed contact on one of the connected organization's contact lists. A real, external, hard-to-fully-undo mail delivery under the organization's own sending domain — there is no unsend. The division must already have a committed schedule (generate and commit one first). This action takes effect only after a human signed in to Hollis has reviewed and approved it, and cannot be redeemed a second time for a different division, a different list, or a schedule that has since changed. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division whose committed schedule to distribute. | | contact\_list\_id | integer | yes | The id of the contact list to send the schedule to. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - CHANGE - email-schedule Emails each registered player in a division their own team's published games (one email per person, transactional). Use after publishing the schedule; returns how many people were emailed. Refused while the program is still draft. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division whose published schedule to email. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - generate-schedule Generates or regenerates a round-robin schedule for a division. Refused, with nothing written, when the rounds need more weeks than a weeks\_of\_play a person set; the refusal says by how much and what to change. While weeks\_of\_play follows the published schedule, a regenerate that makes the season longer is not refused and its confirmation says how many weeks longer and the new end. Never places a game today or earlier: placing starts on the first game day after today, games already played (today and before, not cancelled or held) are kept and count toward the round robin, and the confirmation says how many stay and where placing starts. A first generation (no existing games) writes immediately. Regenerating replaces every generated game with a newly generated set, but preserves games you added or edited by hand and cancelled games, so it needs a confirmation round-trip first; with only\_missing every placed game stays and only the games without a slot are placed again. The confirmation lists the games the run writes, and a plan the run would refuse is refused before a confirmation token is issued. Regenerating a schedule already sent to registrants additionally needs a human signed in to Hollis to approve it — call again with the returned confirmation\_token, then again with the approval\_reference that call returns, once a human has approved the request on the web. **Gate** approval | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division to generate a schedule for. | | season\_start | string | yes | ISO date the first round is scheduled on. | | interval\_days | integer | no | Number of days between rounds. Defaults to 7. | | pairing | 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 | 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 | integer | no | Rounds per week (1-3). Defaults to 1. | | only\_missing | boolean | no | Keep every placed game and give slots only to games that have none. Defaults to false (replace every generated game). | | slot\_order | string: "ordered", "random" | no | ordered: first free field and time; random: any free field and time. Defaults to ordered. | | expected\_program\_team\_ids | 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. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | approval\_reference | string | no | The reference Hollis returned with approval\_required when this request was opened. Send it back on a repeat call: it does nothing until a human has approved this exact request at the approval URL, and you cannot approve it yourself. A value you make up matches no request. | - READ - get-game Returns full detail for one game in a division's schedule. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division this game belongs to. | | game\_id | integer | yes | The id of the game to retrieve. | - READ - list-games Lists a division's games, ordered by round then scheduled time. Optionally filter by status (draft, committed, or cancelled). | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division whose games to list. | | status | string | no | Filter by status: draft, committed, or cancelled. Omit to list every non-cancelled game. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - list-organization-schedule Lists every fixture in the connected organization, ordered by date then round. An atom holder (divisions.view) sees every non-cancelled game; an attached-only caller (captain or rostered player) sees only their own team's committed fixtures. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - READ - my-schedule Lists the upcoming committed games for the teams the connected user is on in this organization. Shows nothing for someone not on a roster. - CHANGE - pin-game 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). A game added or edited by hand is already pinned. Held and cancelled games are refused. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division this game belongs to. | | game\_id | integer | yes | The id of the game. | | pinned | boolean | yes | true keeps the game where it is when the schedule is regenerated; false releases it to the generator. | - CHANGE - schedule-makeup 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. The cancelled game stays, marked made up. Refused for a game not in the queue. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division the cancelled game belongs to. | | game\_id | integer | yes | The id of the cancelled game in the make-up queue. | | scheduled\_at | 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 | integer | yes | The field it is played on. | | duration\_minutes | integer | no | Its length; defaults to the cancelled game's. | - CHANGE - update-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. Only the fields supplied are changed; omitted fields are left as they are. Both teams must already be entered in the division. Moving a game onto a day an assigned referee or crew member is away takes them off it: that first call previews who comes off and writes nothing; call again with the returned confirmation\_token to move it. A game that needs a place (status held) is placed by giving it sub\_location\_id, scheduled\_at and duration\_minutes together, and nothing else about it can be changed until then; once placed it is a draft until the schedule is published again, and teams who had it keep seeing Time TBD until then. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division this game belongs to. | | game\_id | integer | yes | The id of the game to update. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | | round\_number | integer | no | Which round of the schedule this game belongs to. | | scheduled\_at | 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 | integer | no | The id of the home team's entry in this program. Must already be entered in this division. | | away\_program\_team\_id | 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 | 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 | integer | no | How long this game runs, in minutes. Required if sub\_location\_id is set. | | keep\_here | 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. | ## Scoring - CHANGE - ask-official-for-score Emails the official assigned to a game that has started and has no score, asking for the score with a link to enter it. Recorded in the program history. At most once an hour per game. | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The id of the game that has no score. | - CHANGE - confirm-game-result Confirms a score the other team's captain entered, so it counts in the official standings. Only the opposing captain or organization staff may confirm; a disputed result is settled by the organizer instead. Unanswered results confirm themselves after 24 hours. | Field | Type | Required | Description | |---|---|---|---| | game\_result\_id | integer | yes | The result to confirm. | - READ - get-division-standings 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. Three points for a win, one for a draw. A fixture that was cancelled or not played contributes nothing and is not counted as missing. Nothing is assumed for a game with no result — it is listed, never scored as a nil-nil. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The id of the division whose table and missing fixtures to return. | | view | string: "live", "official" | no | live (default) counts every entered score; official counts confirmed, undisputed results only — the table that decides anything. | - READ - list-unscored-games Lists every committed fixture in this organization whose kickoff has passed and which has no result recorded — the work queue behind "record the result". Ordered by kickoff, earliest first. A fixture that was cancelled, or that already carries a terminal disposition (forfeit, abandoned, not played), is RESOLVED and does not appear here. Use record-game-result or record-game-disposition to clear one. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - raise-result-dispute Raises a dispute against a RECORDED result, stating what is being disputed. The result itself is NOT changed and stays live in the standings until somebody settles the dispute and separately re-records the score. A result may carry only ONE open dispute at a time — settle the open one before raising another. A dispute with no stated reason is refused, because it cannot resolve to an outcome. | Field | Type | Required | Description | |---|---|---|---| | game\_result\_id | integer | yes | The id of the recorded result being disputed. Returned by record-game-result and record-game-disposition. | | reason | 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. | - CHANGE - record-game-disposition Records what happened to a fixture that produced NO played score: forfeit, abandoned, not\_played or cancelled. There is no default — name one. Use record-game-result for a game that was played; this tool refuses `played`. A forfeit needs forfeit\_winner (home or away) and the score is decided by Hollis, not by you. Only an abandoned game may carry scores. Recording a second time OVERWRITES the stored result and keeps the previous one in the revision history, attributed to you. | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The id of the fixture whose disposition to record. | | result\_type | 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 | 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 | 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 | integer | no | Goals the AWAY team had scored when the game was abandoned. Accepted only for an abandoned game. | | reason | string | no | Why the result is being changed. Recorded on the revision when this overwrites an existing result. | - CHANGE - record-game-result Records the PLAYED score for a fixture — the two teams turned up and the game finished. If the game did not produce a score (forfeit, abandoned, not played, cancelled) use record-game-disposition instead; this tool refuses a disposition and that tool refuses a score. Recording a second time OVERWRITES the stored result and keeps the previous one in the revision history, attributed to you; pass `reason` to say why. A cancelled fixture has no played result. | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The id of the fixture whose played result to record. | | home\_score | 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 | integer | yes | Goals scored by the AWAY team. Required, for the same reason as home\_score. | | reason | string | no | Why the result is being changed. Recorded on the revision when this overwrites an existing result; ignored on a first recording. | - CHANGE - remove-game-result Removes a game's recorded result, so the game reads as unscored again in standings and the unscored queue. Its history is kept. The first call previews what would happen and writes nothing; call again with the returned confirmation\_token to remove it. Refused while the result is disputed. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The id of the game whose result to remove. | | reason | string | no | Why, kept in the result's history. Optional. | | confirmation\_token | string | no | The token the first call returned; send it to actually remove the result. | - CHANGE - settle-result-dispute Settles an OPEN dispute to a stated outcome: upheld, rejected or withdrawn. A settlement is FINAL — it cannot be revised, and settling an already-settled dispute is refused. Upholding a dispute does NOT change the score: if the result is wrong, record it again with record-game-result, which is a separate act with its own attribution and its own revision entry. A settlement with no stated outcome is refused. | Field | Type | Required | Description | |---|---|---|---| | dispute\_id | integer | yes | The id of the OPEN dispute to settle. Returned by raise-result-dispute. | | status | 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 | 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. | ## Sub - CHANGE - accept-sub-call The caller takes a place a sub call offers, if they are on that division's bench, not on either team in the game, and the call is not yet filled. They are recorded as a sub for that game and team, and the team's captain and co-captain are emailed. Use pay-sub-fee to pay now, or they pay the referee at kickoff. | Field | Type | Required | Description | |---|---|---|---| | sub\_call\_id | integer | yes | The sub call to take a place in. | - CHANGE - call-subs 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. Only the team's captain or co-captain, or someone who manages its roster. Each person on the bench is emailed, in the order they joined, with the per-game fee and a one-tap link; the first to accept fill the places. | Field | Type | Required | Description | |---|---|---|---| | game\_id | integer | yes | The game the team is short for. | | program\_team\_id | integer | yes | The per-program team instance that is short. | - CHANGE - join-bench Puts the caller on a division's on-call bench of substitutes. They accept the program's waiver and that a sub pays the per-game fee, now or to the referee at kickoff. When a team is short for a game, its captain can call the bench, earliest joiner first. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division whose bench to join. | | waiver\_accepted | boolean | yes | The caller accepts the program's waiver. Must be true. | | signed\_name | 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 | boolean | yes | The caller understands a sub pays the per-game fee. Must be true. | - CHANGE - leave-bench Takes the caller off a division's on-call bench. A game they already agreed to sub in is unchanged. | Field | Type | Required | Description | |---|---|---|---| | division\_id | integer | yes | The division whose bench to leave. | - READ - my-sub-calls Returns the divisions whose bench the caller is on, the open sub calls to those benches for games not yet started, and the games the caller is subbing in with whether their fee is paid. - CHANGE - pay-sub-fee Starts paying the caller's own per-game sub fee online and returns a checkout\_url to send them to. A second call returns the same checkout while it is open. Paying the referee at kickoff is also allowed. | Field | Type | Required | Description | |---|---|---|---| | game\_substitute\_id | integer | yes | The caller's own sub record (from accept-sub-call or my-sub-calls). | - CHANGE - set-auto-call-subs Switches automatic sub calls on or off for one team. When on, if the team is short of the game-ready minimum by yes RSVPs 48 hours before a game, the division's bench is called in the captain's name, as if the captain had pressed Call subs. Off by default. Only the team's captain or co-captain, or someone who manages its roster. | Field | Type | Required | Description | |---|---|---|---| | program\_team\_id | integer | yes | The per-program team instance. | | on | boolean | yes | true to call the bench automatically at T-48h when short; false for the captain's tap only. | ## Task - CHANGE - close-task Closes a task. The first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually close it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | feeder\_key | string | yes | The registry key of the task type to close. | | subject\_key | string | yes | The stable subject identifier for this task instance. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - create-ad-hoc-task Creates an ad-hoc task with no feeder behind it. | Field | Type | Required | Description | |---|---|---|---| | title | string | yes | The title of the ad-hoc task. | | description | string \| null | no | An optional description of the ad-hoc task. | | remind\_on | string \| null | no | An optional reminder date, YYYY-MM-DD. | | assigned\_user\_id | integer \| null | no | An optional member who works the task list, to put it on their list. | | category | string \| null | no | Optional; one of: Payments, Locations, Referees, Teams, Player questions. | - CHANGE - delete-ad-hoc-task Deletes a task a person added. Tasks from Hollis cannot be deleted; they clear themselves when fixed. The first call previews and writes nothing; call again with the returned confirmation\_token to delete. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | task\_id | integer | yes | The id of the task to delete. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - dismiss-task Dismisses a task. The first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually dismiss it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | feeder\_key | string | yes | The registry key of the task type to dismiss. | | subject\_key | string | yes | The stable subject identifier for this task instance. | | reason | string | yes | Why this task is being dismissed. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - list-tasks Lists the tasks you can act on in the connected organization: your own tasks and the ones Hollis raises (a lapsed payment hold, a team without a captain, a game with no result). Each row carries the feeder\_key and subject\_key that close-task, dismiss-task and snooze-task take. Optionally narrow by tab (open, mine, hollis, done) or category. | Field | Type | Required | Description | |---|---|---|---| | tab | string | no | Which tasks: open, mine, hollis, done. Defaults to open. | | category | string | no | Narrow to one category: Payments, Locations, Referees, Teams, Player questions. | | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - reopen-task Puts a task back on the open list: a snoozed task before its snooze ends, or a person's own (ad-hoc) task that was marked done. Who closed it stays on record. A task raised by Hollis stays closed once closed, and a dismissed task stays dismissed. | Field | Type | Required | Description | |---|---|---|---| | feeder\_key | string | yes | The registry key of the task type. | | subject\_key | string | yes | The stable subject identifier for this task instance. | - CHANGE - snooze-task Snoozes a task until a date or event. The first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually snooze it. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | feeder\_key | string | yes | The registry key of the task type to snooze. | | subject\_key | string | yes | The stable subject identifier for this task instance. | | snooze\_until | string \| null | no | An ISO date to snooze until. Provide exactly one of snooze\_until or snooze\_event. | | snooze\_event | string \| null | no | A declared event name to snooze until. Provide exactly one of snooze\_until or snooze\_event. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - CHANGE - update-ad-hoc-task Changes a task a person added: its title, note, reminder date, who it is assigned to, or its category. Only the fields you send change; send null to clear one. | Field | Type | Required | Description | |---|---|---|---| | task\_id | integer | yes | The id of the task, as create-ad-hoc-task returned it. | | title | string | no | What needs doing. | | description | string \| null | no | A note. | | remind\_on | string \| null | no | The reminder date, YYYY-MM-DD, or null for none. | | assigned\_user\_id | integer \| null | no | A member who works the task list, or null for nobody. | | category | string \| null | no | One of: Payments, Locations, Referees, Teams, Player questions; or null. | ## Team - CHANGE - create-team Creates a persisted team in the connected organization. A team belongs to no program until entered into one. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The name of the team to create. | - CHANGE - delete-team Retires a team from the organization. Destroys data: the first call previews what would happen and writes nothing; call again with the returned confirmation\_token to actually retire it. The retirement is a soft delete — nothing is permanently destroyed by this tool, and its per-program history rows are soft-deleted along with it. Registrations on those with nothing paid, signed or not, are cancelled; each paid player becomes a task to refund or credit them (no money moves here; to settle one now, call refund-registration for their registration, under its own approval). Games not yet played keep their slot with a stand-in side, "Pending Team #N"; games already played keep the team's name and score. **Gate** confirm | Field | Type | Required | Description | |---|---|---|---| | team\_id | integer | yes | The id of the team to retire. | | confirmation\_token | string | no | Token returned by a prior call to confirm this exact action. | - READ - get-team Returns full detail for one team in the connected organization, including every program it has entered. | Field | Type | Required | Description | |---|---|---|---| | team\_id | integer | yes | The id of the team to retrieve. | - READ - list-teams Lists persisted teams in the connected organization. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - update-team Renames a team. Only the fields supplied are changed; omitted fields are left as they are. The team's slug never changes as a result of this call. | Field | Type | Required | Description | |---|---|---|---| | team\_id | integer | yes | The id of the team to update. | | name | string | no | The new name of the team. | ## Utilisation - READ - get-utilisation-ledger Computes the classified, priced location-hour utilisation ledger (booked/empty/blacked-out/wasted-in-prime), rolled up by area, in the connected organization. A draft game books its hour (draft: true on the segment), so a schedule read before publish shows the plan. | Field | Type | Required | Description | |---|---|---|---| | location\_id | integer | no | Optional location filter. | | program\_id | integer | no | Optional program filter. | | area\_id | integer | no | Optional area filter. A level-1 area includes its level-2 areas. | | from | string | yes | Start of the date range. | | to | string | yes | End of the date range, within one year of from. | ## Waiver - CHANGE - create-waiver Adds a waiver to the organization at version 1. With is\_default true it becomes the default, which every program without an assigned waiver asks registrants to accept. Hollis records acceptance of the text; it is not an e-signature product. | Field | Type | Required | Description | |---|---|---|---| | name | string | yes | The waiver's name, unique in the organization, e.g. "Indoor facilities waiver". | | body | string | yes | The full text a registrant accepts, as Markdown: \*\*bold\*\*, \*italic\*, # headings, lists and links are shown formatted; a single newline is a line break. Stored and returned as typed. | | is\_default | boolean | no | Make this the organization's default waiver. Defaults to false. | - READ - get-waiver One of the organization's waivers: its current text and version, and the text of every earlier version (an acceptance records the version it accepted). | Field | Type | Required | Description | |---|---|---|---| | waiver\_id | integer | yes | The id of the waiver (list-waivers). | - READ - list-waivers Lists the organization's waivers, the default first: id, name, current version and whether it is the default. A program uses its assigned waiver, or the default when none is assigned. Use get-waiver for the text. | Field | Type | Required | Description | |---|---|---|---| | cursor | string | no | Opaque pagination cursor returned by a previous call. | | limit | integer | no | Maximum number of items to return (capped at 100). | - CHANGE - update-waiver Renames a waiver, changes its text, or makes it the default. A changed text is a NEW VERSION: earlier versions and the acceptances recorded against them are kept, and registrants accept the new version from their next registration. The default cannot be un-set directly; make another waiver the default instead. | Field | Type | Required | Description | |---|---|---|---| | waiver\_id | integer | yes | The id of the waiver (list-waivers). | | name | string | no | A new name, unique in the organization. | | body | string | no | The new full text, as Markdown (shown formatted; returned as typed). Moves the waiver to its next version when it differs from the current text. | | is\_default | boolean | no | true makes this the organization's default waiver. |