API reference

setDetails — Set wedding details: names, date (exact / month / unknown), guest range or the exact guest estimate (guestCount; it sets the range), ceremony, style template, time format, whether the Big Day board shows prices (showPrices), currency, total budget target, region. Only the given fields change; currency never converts amounts.

finishOnboarding — Mark the first-run questions as answered (the planner stops asking them).

activateItem — Add a suggested vendor category (e.g. "fireworks", "bar") to the vendor list.

addCustomItem — Add the couple's own vendor type (id chosen by the caller), in a category.

setItemStatus — Set a vendor status: idea, comparing, booked or done.

markItemCovered — Mark a vendor as included in the venue package.

markItemNotNeeded — Mark a vendor as not needed.

undoItemBanner — Undo "covered" / "not needed" (back to idea or comparing).

renameItem — Give a vendor item the couple's own name; on a catalogue item an empty name goes back to the catalogue name.

removeCustomItem — Delete one of the couple's own vendor items (catalogue items can only be marked not needed). Its moments stay, unlinked.

restoreItem — Put a deleted own vendor item back with its options, to-dos, payments and notes, re-linking its moments (undo).

addItemNote — Add a dated entry to a vendor's "Agreements & notes" log (date YYYY-MM-DD or empty; multi-line text).

updateItemNote — Change the date or text of an "Agreements & notes" entry.

removeItemNote — Remove an "Agreements & notes" entry.

restoreItemNote — Put a removed "Agreements & notes" entry back (undo).

addOption — Add an option (a concrete vendor / offer) to compare under a vendor item; optional name and fixed amount.

updateOption — Change an option: name, price model (fixed / per person / both), amounts, contact, web, notes.

setOptionField — Set a comparison field of an option (e.g. capacity, style).

toggleOptionInclude — Venue options: toggle what the venue package includes (catering, stay, decor, music, rentals).

rateOption — Rate an option 1–5 for one partner (the same stars again clears it).

toggleChosen — Choose / un-choose an option (multi-choice items keep several).

setChosen — Choose exactly this option (null = none).

removeOption — Remove an option.

restoreOption — Put a removed option back (undo).

setItemBudget — Set the budget of one vendor item (0 = none).

addPayment — Add a payment to a vendor item.

updatePayment — Change a payment: label, amount, due date, paid.

removePayment — Remove a payment.

restorePayment — Put a removed payment back (undo).

addTodo — Add a to-do, either general (with a section) or on a vendor item, with optional multi-line notes.

updateTodo — Change a to-do: title, due date, section, notes (empty = none).

pinTodo — Pin one of the couple's own to-dos to the top of the list (pinned: false unpins).

movePinnedTodo — Move a pinned to-do up (-1) or down (1) among the pinned ones.

toggleTodo — Tick / untick a to-do.

removeTodo — Remove a to-do.

dismissSuggestion — Hide a suggested to-do.

restoreSuggestion — Show a hidden suggestion again.

addParty — Add one invitation (a party: single, plus-one, couple or family) with its people. The caller chooses the ids; the server picks the RSVP token (send any 16–64 characters as `rsvpToken`; they are replaced). Read the link with GET /api/v2/guests/{partyId}/link.

addParties — Add up to 500 invitations at once (bulk import). The server picks every RSVP token, as for addParty.

updateParty — Replace an invitation’s details and people (replies and seats are kept).

removeParties — Remove invitations (and free their seats).

setReply — Record an RSVP answer by hand: waiting, yes (with who is coming) or no, plus diets (free text and fixed `dietTags`), room and bus (null = not answered). Shown as "Manually entered".

setInvited — Mark invitations as invited without e-mail (paper, WhatsApp): not-sent ones become "waiting for a reply" and use no free send. `invited: false` puts still-waiting ones back to "not invited yet".

newRsvpLink — Give an invitation a new personal RSVP link; the old link stops working. The server picks the new token (send any 16–64 characters; they are replaced).

revertToGuestAnswer — Put back the guest’s own last answer from the RSVP page over changes made by hand (NOTHING_TO_REVERT when the guest never answered online).

updateRsvpSettings — RSVP form settings: ask dietary / accommodation / bus, PIN, message templates.

setBusPickupPlace — Where the guest bus picks up.

seatParty — Seat everyone of an invitation who has no seat yet at one table, from `seatIndex` on (all or nothing: NOT_ENOUGH_SEATS).

addTable — Add a table (round, 8 seats; it appears on the floor plan).

updateTable — Change a table: name, shape, capacity (2–24).

removeTable — Remove a table.

seat — Seat one person of an invitation on a given seat.

unseat — Free one seat.

seatFirstFree — Seat one person of an invitation on the first free seat of a table.

unseatOne — Free one seat of an invitation at a table.

applySeatingPreset — Lay out a whole empty seat planner at once: "round" (round head table + rounds), "banquet" (long head table + long rows of 20–24) or "mixed" (long head table + rounds), sized for `guests` (default: the guest estimate or the yes count, whichever is larger), on the floor plan with the head table at the front. Table ids are `{presetId}-1`… and `{presetId}-h` (head). Refused once tables exist (TABLES_EXIST) or when the stored room is too small (ROOM_TOO_SMALL).

addTablesLike — Add tables with the same shape and capacity as an existing one, numbered after the last "Table n".

removeTables — Remove several tables at once (frees their seats). `restoreRoom` puts the room size back (undo of applySeatingPreset; null = the automatic room).

moveTable — Place a table on the floor plan (centre, metres from the top-left corner).

rotateTable — Rotate a table on the floor plan (degrees).

setFloorSize — Set the room size (metres).

addFloorElement — Add a dance floor, stage, bar, buffet… to the floor plan.

updateFloorElement — Move, resize, rotate or rename a floor plan element.

removeFloorElement — Remove a floor plan element.

createVersion — Copy a day version into a new alternative day (Premium).

renameVersion — Rename a day version.

removeVersion — Remove an alternative day version.

restoreVersion — Put a removed version back (undo; Premium).

makePlan — Make an alternative day the plan.

useOptionInPlan — Use an option of a vendor in the plan.

useMomentInPlan — Copy a moment from an alternative day into the plan.

addMoment — Add a moment (time, name, lane, icon) to a day version; the plan is the version with isPlan = true.

updateMoment — Change a moment: name, time, lane, icon, duration; oldPick null dismisses the "in your old plan this moment used…" note a migrated plan may carry.

moveMoment — Move a moment to a lane and a time slot.

linkMoment — Link a moment to a vendor item (null unlinks).

createItemForMoment — Create a vendor item for a moment and link it.

setMomentOption — Alternative days: pick which option a linked vendor uses.

addOptionForMoment — Add an option to the vendor linked to a moment.

setMomentItemStatus — Set the status of the vendor linked to a moment.

duplicateMoment — Duplicate a moment.

removeMoment — Remove a moment.

addItemToDay — Put a vendor item on the plan as a moment.

setTemplate — Choose the design template (0 blush, 1 midnight, 2 industrial, 3 garden, 4 golden hour).

setAccent — Set the couple’s own accent colour (#rrggbb) for the website and printables; null = the template’s.

newSiteLink — Give the wedding website a new public link; the old link stops working. The server picks the new slug.

setSiteSection — Show / hide a section of the wedding website.

moveSiteSection — Move a website section up or down.

setSitePublished — Publish / unpublish the wedding website (publishing needs Premium).

updateSite — Change website texts: guest language, welcome, story, dress code, venue name and address, getting there (travelText), where to stay (stayText), RSVP deadline and RSVP note, vendor names on the day timeline (showVendors), search-engine visibility (indexable).

updatePhoto — Rename a photo.

removePhoto — Remove a photo.

setDesignStatus — Set a design’s status: not started, draft, done.

setDesignText — Override a text block of a design (null = follow the planner again).

setDesignPhotos — Set the photos of a design slot, in order.

setDesignStyle — Design style: show photo, alignment, paper size, include guests who haven't replied (seating chart, name cards; on unless false), print cards for people without a name (name cards), landscape orientation (every printable with a paper choice), a QR code to the published website (save-the-date, invitation).

addMenuSection — Add a section to the table menu (Starters, Main course…).

renameMenuSection — Rename a menu section.

moveMenuSection — Move a menu section up or down.

removeMenuSection — Remove a menu section.

restoreMenuSection — Put a removed menu section back (undo).

addMenuItem — Add a dish or drink to a menu section.

updateMenuItem — Change a dish: name, note.

moveMenuItem — Move a dish up or down.

removeMenuItem — Remove a dish.

restoreMenuItem — Put a removed dish back (undo).