Login - YoPlanning : online booking and planning software

Showing 25 of 208 from the live probe.

• Preferences List

  **Read the calling user's settings/preferences** (the "gear" panel, /planning/settings) — these are **per-user, not per-team**. Returns a flat object of the effective preferences (your saved values, or their defaults when never changed): ```json { "week_start": 0, "start_working_hour": 8, "end_working_hour": 18, "row_height": 70, "session_color": 5, "reminder_time": 0, "magnet_enabled": 1, "session_tooltip": 1, "online_selling_info": 1, "filter_on_drag": 0, "move_group": 0, "user_timezon

• Preferences Update

  **Update the calling user's settings/preferences** (per-user, not per-team). Send only the fields you want to change — **omitted fields keep their current value** (partial upsert, exactly like the app's settings panel). Booleans are `0`/`1`. `language` is NOT a preference here (managed elsewhere). Returns the full updated preferences object (same shape as GET). **Responses:** - **200** (Success): No description.

• Teams List

  **List the teams you have access to** (the ones in your left-hand menu). Read-only, lightweight items — each carries the `id` you pass as `{teamId}` everywhere else, plus a few identity fields. ```json {"count": 2, "results": [ {"id": "6c18e4b4-…", "name": "Saraswati", "currency": "CAD", "country": "FR", "language": "fr", "timezone": "Europe/Paris"} ]} ``` *GET* only. Paginated (`?limit`/`?offset`). Use `GET /teams/{teamId}` for the full team object. **Query Parameters:** - **ordering**:

• Teams Create

  **Create a new team** for the calling user (same path as the "create a team" button under the team list; bridges to `TeamGenerator.addTeam` + `sendNewTeamMessage`). You (the token holder) are automatically added to the new team as **administrator** — you cannot create a team for someone else. ### Minimum input Only three fields are read (`CreateTeamForm`): - `name` — **required**. The team / organisation name. It is **normalised** before being stored: a url scheme (`https://`, `www.`) and any c

• Teams Read

  A **Team** is the organisation/account itself : the top-level container that owns every other resource (products, staff, roles, orders…). It also holds the team's identity, contact, banking, accounting and legal settings. On this endpoint you can **list your teams** (`GET /teams`), **create a team** (`POST /teams`), **read** one (`GET /teams/{teamId}`) and **update** its settings (`PUT /teams/{teamId}`, a partial merge — omitted fields are kept). You **cannot delete** a team here. ### Team obje

• Teams Update

  **Update** (PUT) a **Team**'s settings. Updates are a **partial merge**: send only the fields you want to change — anything you **omit keeps its current value** (the server reloads it), so you never risk wiping data you didn't touch. A field you send replaces it; send `null` (or `[]` for a list) to clear it. Bridges to the same internal `teamService.modifyTeam` used by the app's update-team-info screen (`TeamInfoForm` + `TeamAdvancedSettingsForm`). The simplest safe update is to send only the fi

• Teams Activity Sectors List

  Yoplanning's **global activity sectors** — read-only, shared reference data (not team-specific). Use it to **discover the `activity_sector_id`** required when creating a team (`POST /teams`). ### Response The **full list** is returned (no pagination): ```json [ {"id": 1, "name": "Outdoor sports"}, {"id": 2, "name": "Water sports"} ] ``` Pick an `id` and pass it as `activity_sector_id` when creating a team. *GET* (list) only. *POST/PUT/DELETE* are not supported (405) — managed by Yoplanning

• Teams Attendances List

  For resource description and JSON, please see [reference](#/operations/teams_agent-attendances_read). *GET* : return the team's attendances (bridged on the app's own filtered listing — same filters, same results). See "Pagination". *POST* : create one attendance. ### Filters (query params) - `start_date` / `end_date` (`YYYY-MM-DD`) — keep attendances whose **`start_date` falls within `[start_date, end_date]`** (this filters on the period's start day, **not** on period overlap — same semant

• Teams Attendances Create

  Create **ONE Attendance** — a single team member's work period (`start_date → end_date` carrying a `staff_status`). This resource is **not batch**: one POST = one attendance for one teacher; loop client-side to cover several members. ### Minimal body (all four fields are required) ```json { "start_date": "2026-06-09", "end_date": "2026-07-09", "teacher": {"id": "1d80198f-92f4-4319-aeb7-78f38a183b41"}, "staff_status": {"id": "a30e4574-7c78-4aef-a5be-7cdb06f793f7"} } ``` - `start_date

• Teams Attendances Batchdelete

  **Bulk-delete** attendances — by an explicit id list **or** by the LIST filters (minus `except_ids`). For deleting a SINGLE attendance use `DELETE /{id}` instead. Body — provide **either** `ids` **or** `filters`: ```json { "selection": { "ids": ["<uuid>", "<uuid>"] } } ``` ```json { "selection": { "filters": {"teacher_id": "<uuid>", "start_date": "2026-06-01", "end_date": "2026-06-30"}, "except_ids": ["<uuid>"] } } ``` - `selection.ids` — explicit rows to delete (manual selecti

• Teams Attendances Read

  An **Attendance** records **ONE team member's work period** — a `start_date → end_date` date range carrying a **staff status** (the kind of duty : e.g. "on duty", "available", a custom status defined for the team). It is the building block of a team member's work calendar. Attendances are **team-scoped** — `/teams/{teamId}/attendances` (not nested under a session). ### Attendance object (GET) ```json { "id": "cacec28a-3812-4838-8e10-d856280cd769", "start_date": "2026-06-09", "end_date"

• Teams Attendances Delete

  Delete **ONE Attendance** by id (`DELETE /{id}`). ### What it does - **Hard-deletes** the single attendance row (a real DB delete, team-scoped — not a soft archive, no `status` flag). - An Attendance is a leaf record: deleting it removes only that one work period. It does **not** cascade to the teacher, the staff status, or any session — those are untouched. ### Notes - Team-scoped: only an attendance belonging to the path team (`/teams/{teamId}/attendances/{id}`) can be targeted; an id outsid

• Teams Booking Engine Products List

  The team's **booking-engine products** across ALL booking engines — each item is a booking_engine↔product association; the only setting is `enabled` (sold online or not). Read-only list; edit in bulk via `batch_update`. Product and booking engine exposed by NAME only; use the id filters to target them. ### Filters (query params, all optional) - `booking_engine_id` — only this booking engine (UUID). - `product_id` — only this product (UUID). - `product_tag_id` — only products carrying this produ

• Teams Booking Engine Products Batchupdate

  **Bulk-toggle online sale** on many booking-engine associations at once. This is the ONLY way to write these resources: the standard verbs are disabled here — `POST`/`PUT`/`DELETE` on an item and `GET /{id}` all return **405**. Associations are created/removed elsewhere (on the Product / Resource itself); here you can only flip whether each existing association is `enabled` (sold online) or not. Endpoint: `POST /teams/{teamId}/booking_engine_products/batch_update` (and the identical `.../bookin

• Teams Booking Engine Resources List

  The team's **booking-engine resources** across ALL booking engines — each item is a booking_engine↔resource association; the only setting is `enabled` (sold online or not). Read-only list; edit in bulk via `batch_update`. Resource and booking engine exposed by NAME only; use the id filters. ### Filters (query params, all optional) - `booking_engine_id` — only this booking engine (UUID). - `resource_id` — only this resource (UUID). - `status` — `enabled` / `disabled`. Omit for all. *GET* (list)

• Teams Booking Engine Resources Batchupdate

  **Bulk-toggle online sale** on many booking-engine associations at once. This is the ONLY way to write these resources: the standard verbs are disabled here — `POST`/`PUT`/`DELETE` on an item and `GET /{id}` all return **405**. Associations are created/removed elsewhere (on the Product / Resource itself); here you can only flip whether each existing association is `enabled` (sold online) or not. Endpoint: `POST /teams/{teamId}/booking_engine_products/batch_update` (and the identical `.../bookin

• Teams Booking Engines List

  For resource description and JSON, please see [reference](#/operations/teams_booking_engines_read). *GET* : return all the team's booking engines. Filter by name with `?name=` (case-insensitive substring). See "Pagination". *POST* : create a new one (the id is generated server-side). **Path Parameters:** - **teamId** (Required): No description. **Query Parameters:** - **name**: name - **ordering**: Which field to use when ordering the results. - **limit**: Number of results to return p

• Teams Booking Engines Create

  Create a **BookingEngine** — an online booking module (a configurable shop/checkout page) for the team, from which clients browse and buy the team's products. ### Minimal body Only `name` is required: ```json {"name": "My module"} ``` Each field is documented individually on its parameter below. ### Defaults & server-set values - `team_id` comes from your token — **never send it**. - **Every boolean you omit is stored as `false`.** ⚠️ This includes `deposit_percentage`, `show_nb_remaining_tick

• Teams Booking Engines Read

  A **BookingEngine** is an online booking module (a configurable shop/checkout) for a team. ### BookingEngine object ```json { "id": "60031613-e967-4056-9b4d-c60b8de92404", "name": "My module", "success_url": "https://example.com/thanks", "shortcut": "Mod", "billing_address_required": 0, "phone_number_required": 1, "product_filter_type": 1, "product_view_type": "list", "forced_lang": "", "deposit": null, "deposit_percentage": true, "main": false, "multiple_

• Teams Booking Engines Update

  **Update** a **BookingEngine** (PUT). Updates are a **partial merge**: send only the fields you want to change — anything you **omit keeps its current value** (the server reloads it), so you never risk wiping data you didn't touch. A field you send replaces it; a list you send replaces that whole list. ### Merge semantics — read carefully - **Booleans** (`deposit_percentage`, `show_nb_remaining_tickets`, `sell_options`, `main`, `google_things_to_do`, `multiple_selection`…): **omit** to keep the

• Teams Booking Engines Delete

  Delete (archive) a **BookingEngine**. The archive is soft for the engine itself, but it clears the engine's product/resource configuration. ### What it does - **Soft-deletes** the engine (status set to DELETED): it leaves the list and can no longer be used for booking. - **Removes all of the engine's product and resource availability rows** (its `BookingEngineProduct` / `BookingEngineResource` links are hard-deleted). Products/resources themselves are untouched — only their presence on THIS eng

• Teams Bookings Create

  **Sell online, in one call.** Creates the order AND enrols the participants on the sessions — unlike the counter-sale flow (`POST /orders`), where the order and the participants are two separate steps. This is the flow to use for a booking whenever the slot is on sale online. **Read the online availabilities first** (`GET /teams/{teamId}/online_availabilities?product_id=…`): they give you the `session_group_id` and the tariffs. A slot that is not in that catalogue cannot be sold here — sell it

• Teams Cart Rules List

  For resource description and JSON, please see [reference](#/operations/teams_cart_rules_read). *GET* : return all the team's cart rules — filter by name with `?search=<text>`. See "Pagination". *POST* : create a new one (the id is generated server-side). **Path Parameters:** - **teamId** (Required): No description. **Query Parameters:** - **ordering**: Which field to use when ordering the results. - **search**: A search term. - **limit**: Number of results to return per page. - **offs

• Teams Cart Rules Create

  Create a **Cart rule** — an automatic checkout promotion of the "buy X, get a discount on Y" kind: when the cart holds enough of a **condition** item, the **promotion** is applied to the matching **effect** item. The customer types nothing (unlike a promo code) and it is driven by the current cart (unlike a marketing rule). ### Minimal body ```json { "name": "Buy X get Y", "condition_session_tag": {"id": "9cd7eb6b-…"}, "effect_product_tag": {"id": "a806a9b8-…"} } ``` Required: `name`,

• Teams Cart Rules Read

  A **Cart rule** is an automatic checkout promotion of the "buy X, get a discount on Y" kind: when the cart contains enough of a **condition** item, a **promotion** is applied to the matching **effect** item. Both the condition and the effect are expressed against a product, a product-tag or a session-tag. Unlike a promo code the customer types nothing; unlike a marketing rule it is driven by what is already in the cart. ### Cart rule object (GET) ```json { "id": "27e2f215-…", "name": "Buy