{"openapi":"3.1.0","info":{"title":"StyleSeat API (Bowmark)","version":"e833508f87ff","description":"StyleSeat marketplace for hair stylists, barbers, braiders, nail, lash and brow pros: search pros near a place by service, a pro's services, prices, open times, reviews and booking quote, salons, and the signed-in client's own appointments, favorites and waitlists.\n\nEvery function Bowmark has for StyleSeat (styleseat.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/styleseat/resolveLocation":{"post":{"operationId":"resolveLocation","summary":"Turns a place a caller typed (\"Brooklyn, NY\", a ZIP code, an address) into the coordinates and formatted place name searchProfessionals searches around.","description":"Turns a place a caller typed (\"Brooklyn, NY\", a ZIP code, an address) into the coordinates and formatted place name searchProfessionals searches around.\n\nCalls `bowmark.providers.styleseat.resolveLocation`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatPlace>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"place":{"type":"string","description":"TypeScript: `string`"}},"required":["place"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/searchProfessionals":{"post":{"operationId":"searchProfessionals","summary":"Searches StyleSeat for hair stylists, barbers, braiders, nail techs, lash and brow artists and other beauty pros near a place, by what the caller wants done (\"box braids\", \"skin fade\").","description":"Searches StyleSeat for hair stylists, barbers, braiders, nail techs, lash and brow artists and other beauty pros near a place, by what the caller wants done (\"box braids\", \"skin fade\"). Returns each pro's id, name, vanity url, salon, rating, photo and matched services with prices and durations.\n\nCalls `bowmark.providers.styleseat.searchProfessionals`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatSearchArgs","description":"TypeScript: `StyleseatSearchArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getProfessional":{"post":{"operationId":"getProfessional","summary":"Gets one StyleSeat pro's public profile from a vanity name, profile url or id: name, business name, address and coordinates, phone where shown, bio, profession, rating, social links, cancellation and ","description":"Gets one StyleSeat pro's public profile from a vanity name, profile url or id: name, business name, address and coordinates, phone where shown, bio, profession, rating, social links, cancellation and deposit policy, and every service group with service id, price, duration and add-ons — the door for the service ids getAvailability and bookAppointment take.\n\nCalls `bowmark.providers.styleseat.getProfessional`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatProfessional>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pro":{"type":"string","description":"TypeScript: `string`"}},"required":["pro"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getAvailability":{"post":{"operationId":"getAvailability","summary":"Lists a pro's open start times for one or more of their services over a date range, as real clock times per day, with any time-of-day surcharge the pro charges for that slot.","description":"Lists a pro's open start times for one or more of their services over a date range, as real clock times per day, with any time-of-day surcharge the pro charges for that slot.\n\nCalls `bowmark.providers.styleseat.getAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatAvailabilityArgs","description":"TypeScript: `StyleseatAvailabilityArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getBookingQuote":{"post":{"operationId":"getBookingQuote","summary":"Prices a prospective appointment before booking — services at a date and start time — and returns StyleSeat's booking fee, the deposit due now and the balance left at the appointment.","description":"Prices a prospective appointment before booking — services at a date and start time — and returns StyleSeat's booking fee, the deposit due now and the balance left at the appointment. Creates nothing.\n\nCalls `bowmark.providers.styleseat.getBookingQuote`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatBookingQuote>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatBookingQuoteArgs","description":"TypeScript: `StyleseatBookingQuoteArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/listServiceCategories":{"post":{"operationId":"listServiceCategories","summary":"Lists StyleSeat's service categories and the services under each, with the search phrase each one maps to — the vocabulary searchProfessionals understands.","description":"Lists StyleSeat's service categories and the services under each, with the search phrase each one maps to — the vocabulary searchProfessionals understands.\n\nCalls `bowmark.providers.styleseat.listServiceCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatServiceCategories>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getReviews":{"post":{"operationId":"getReviews","summary":"Lists a pro's client reviews, newest first, with stars, review text, photos, the service reviewed and the pinned reviews, plus the per-service rating summary.","description":"Lists a pro's client reviews, newest first, with stars, review text, photos, the service reviewed and the pinned reviews, plus the per-service rating summary.\n\nCalls `bowmark.providers.styleseat.getReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatReviewsResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatReviewsArgs","description":"TypeScript: `StyleseatReviewsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getGallery":{"post":{"operationId":"getGallery","summary":"Lists the photos of a pro's portfolio, or every pro's photos at a salon, paged 20 per page.","description":"Lists the photos of a pro's portfolio, or every pro's photos at a salon, paged 20 per page.\n\nCalls `bowmark.providers.styleseat.getGallery`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatGallery>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatGalleryArgs","description":"TypeScript: `StyleseatGalleryArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getSalon":{"post":{"operationId":"getSalon","summary":"Gets a salon's details plus every pro who works there, each with their services, prices and durations — from the salon id or vanity a search result's matched_salon carries.","description":"Gets a salon's details plus every pro who works there, each with their services, prices and durations — from the salon id or vanity a search result's matched_salon carries.\n\nCalls `bowmark.providers.styleseat.getSalon`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatSalon>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"salonId":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["salonId"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getOffers":{"post":{"operationId":"getOffers","summary":"Lists what a pro is offering on top of list prices: active promotions, their loyalty-program reward (e.g.","description":"Lists what a pro is offering on top of list prices: active promotions, their loyalty-program reward (e.g. 20% off after 6 visits) when one is on, and prepaid service packages for sale.\n\nCalls `bowmark.providers.styleseat.getOffers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatOffers>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pro":{"type":"string","description":"TypeScript: `string`"}},"required":["pro"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getAppointmentByLink":{"post":{"operationId":"getAppointmentByLink","summary":"Reads an appointment from the manage link StyleSeat sends in its confirmation email or text, with no sign-in -- pass the link or its token.","description":"Reads an appointment from the manage link StyleSeat sends in its confirmation email or text, with no sign-in -- pass the link or its token. Fields beyond id are read defensively; the full document is in raw.\n\nCalls `bowmark.providers.styleseat.getAppointmentByLink`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatAppointmentByLink>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"],"additionalProperties":true,"description":"TypeScript: `{ token: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/cancelAppointmentByLink":{"post":{"operationId":"cancelAppointmentByLink","summary":"Cancels an appointment from the manage link in StyleSeat's confirmation message, with no sign-in -- for a guest booking a pro made on the client's behalf.","description":"Cancels an appointment from the manage link in StyleSeat's confirmation message, with no sign-in -- for a guest booking a pro made on the client's behalf. Pass the link or its token.\n\nCalls `bowmark.providers.styleseat.cancelAppointmentByLink`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatCancelledByLink>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"],"additionalProperties":true,"description":"TypeScript: `{ token: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/listClassTimes":{"post":{"operationId":"listClassTimes","summary":"Lists a pro's upcoming group classes (workshops, braiding classes, makeup lessons): each time's start, end, class service, spots left and whether it is full.","description":"Lists a pro's upcoming group classes (workshops, braiding classes, makeup lessons): each time's start, end, class service, spots left and whether it is full. Empty for pros who teach none.\n\nCalls `bowmark.providers.styleseat.listClassTimes`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatClassTimes>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatClassTimesArgs","description":"TypeScript: `StyleseatClassTimesArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getMyProfile":{"post":{"operationId":"getMyProfile","summary":"Reads the signed-in caller's StyleSeat client profile: name, email, phone, photo and the user id the account routes take.","description":"Reads the signed-in caller's StyleSeat client profile: name, email, phone, photo and the user id the account routes take. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.getMyProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatMyProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/listMyAppointments":{"post":{"operationId":"listMyAppointments","summary":"Lists the signed-in caller's upcoming and past StyleSeat appointments: pro, services, time, price, status and the appointment id getMyAppointment takes.","description":"Lists the signed-in caller's upcoming and past StyleSeat appointments: pro, services, time, price, status and the appointment id getMyAppointment takes. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.listMyAppointments`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatMyAppointments>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatMyAppointmentsArgs","description":"TypeScript: `StyleseatMyAppointmentsArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/getMyAppointment":{"post":{"operationId":"getMyAppointment","summary":"Gets one of the signed-in caller's appointments in full, by id from listMyAppointments.","description":"Gets one of the signed-in caller's appointments in full, by id from listMyAppointments. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.getMyAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatAppointmentSummary>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"id":{"type":"number"}},"required":["id"],"additionalProperties":true,"description":"TypeScript: `{ id: number }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/bookAppointment":{"post":{"operationId":"bookAppointment","summary":"Books an appointment with a pro for the signed-in caller: services at a date and start time, with a note to the pro.","description":"Books an appointment with a pro for the signed-in caller: services at a date and start time, with a note to the pro. Prices the appointment first and completes only when nothing is charged up front — when the pro requires a deposit or card on file it stops at the quote and never pays. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.bookAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatBookedAppointment>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatBookAppointmentArgs","description":"TypeScript: `StyleseatBookAppointmentArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/cancelAppointment":{"post":{"operationId":"cancelAppointment","summary":"Cancels one of the signed-in caller's upcoming StyleSeat appointments, by id from listMyAppointments.","description":"Cancels one of the signed-in caller's upcoming StyleSeat appointments, by id from listMyAppointments. A late cancel can forfeit a deposit under the pro's policy — getProfessional shows it. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.cancelAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatCancelledAppointment>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"id":{"type":"number"}},"required":["id"],"additionalProperties":true,"description":"TypeScript: `{ id: number }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/rescheduleAppointment":{"post":{"operationId":"rescheduleAppointment","summary":"Moves one of the signed-in caller's appointments to a new date and start time with the same pro and services — take a free slot from getAvailability first.","description":"Moves one of the signed-in caller's appointments to a new date and start time with the same pro and services — take a free slot from getAvailability first. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.rescheduleAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatRescheduledAppointment>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatRescheduleArgs","description":"TypeScript: `StyleseatRescheduleArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/joinWaitlist":{"post":{"operationId":"joinWaitlist","summary":"Puts the signed-in caller on a pro's waitlist for chosen services, with a note, when no open time suits — the pro is notified.","description":"Puts the signed-in caller on a pro's waitlist for chosen services, with a note, when no open time suits — the pro is notified. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.joinWaitlist`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatWaitlistEntry>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatJoinWaitlistArgs","description":"TypeScript: `StyleseatJoinWaitlistArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/listFavorites":{"post":{"operationId":"listFavorites","summary":"Lists the pros the signed-in caller has saved as favorites on StyleSeat, with each pro's id and vanity for getProfessional.","description":"Lists the pros the signed-in caller has saved as favorites on StyleSeat, with each pro's id and vanity for getProfessional. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.listFavorites`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatFavorites>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"page":{"type":"number"},"size":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ page?: number; size?: number }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/addFavorite":{"post":{"operationId":"addFavorite","summary":"Saves a pro (vanity, numeric id or profile url) to the signed-in caller's StyleSeat favorites.","description":"Saves a pro (vanity, numeric id or profile url) to the signed-in caller's StyleSeat favorites. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.addFavorite`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatFavoriteChange>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"pro":{"type":"string"}},"required":["pro"],"additionalProperties":true,"description":"TypeScript: `{ pro: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/removeFavorite":{"post":{"operationId":"removeFavorite","summary":"Removes a pro from the signed-in caller's StyleSeat favorites.","description":"Removes a pro from the signed-in caller's StyleSeat favorites. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.removeFavorite`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatFavoriteChange>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"pro":{"type":"string"}},"required":["pro"],"additionalProperties":true,"description":"TypeScript: `{ pro: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/updateMyProfile":{"post":{"operationId":"updateMyProfile","summary":"Changes the signed-in caller's StyleSeat first name, last name or phone — only the fields given — and returns the profile.","description":"Changes the signed-in caller's StyleSeat first name, last name or phone — only the fields given — and returns the profile. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.updateMyProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatMyProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatUpdateProfileArgs","description":"TypeScript: `StyleseatUpdateProfileArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/listMyDiscounts":{"post":{"operationId":"listMyDiscounts","summary":"Lists the discount codes saved on the signed-in caller's StyleSeat account.","description":"Lists the discount codes saved on the signed-in caller's StyleSeat account. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.listMyDiscounts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatMyDiscounts>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/sendMessageToProfessional":{"post":{"operationId":"sendMessageToProfessional","summary":"Opens a chat conversation with a pro (the door StyleSeat's own messaging goes through).","description":"Opens a chat conversation with a pro (the door StyleSeat's own messaging goes through). Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.sendMessageToProfessional`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatConversation>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"pro":{"type":"string"},"message":{"type":"string"}},"required":["pro","message"],"additionalProperties":true,"description":"TypeScript: `{ pro: string; message: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/styleseat/leaveReview":{"post":{"operationId":"leaveReview","summary":"Leaves a star rating and review for a pro, from the feedback token in StyleSeat's review-request email or text.","description":"Leaves a star rating and review for a pro, from the feedback token in StyleSeat's review-request email or text. Needs the caller signed in — the run pauses for a login link when they are not.\n\nCalls `bowmark.providers.styleseat.leaveReview`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StyleseatLeftReview>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/StyleseatLeaveReviewArgs","description":"TypeScript: `StyleseatLeaveReviewArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"StyleseatAvailabilityArgs":{"type":"object","properties":{"pro":{"type":"string"},"serviceIds":{"type":"array","items":{"type":"number"}},"startDate":{"type":"string"},"days":{"type":"number"}},"required":["pro","serviceIds"],"additionalProperties":true},"StyleseatBookAppointmentArgs":{"type":"object","properties":{"pro":{"type":"string"},"serviceIds":{"type":"array","items":{"type":"number"}},"date":{"type":"string"},"startTime":{"type":"string"},"note":{"type":"string"}},"required":["pro","serviceIds","date","startTime"],"additionalProperties":true},"StyleseatBookingQuoteArgs":{"type":"object","properties":{"pro":{"type":"string"},"serviceIds":{"type":"array","items":{"type":"number"}},"date":{"type":"string"},"startTime":{"type":"string"}},"required":["pro","serviceIds","date","startTime"],"additionalProperties":true},"StyleseatClassTimesArgs":{"type":"object","properties":{"pro":{"type":"string"},"serviceId":{"anyOf":[{"type":"string"},{"type":"number"}]},"offset":{"type":"number"}},"required":["pro"],"additionalProperties":true},"StyleseatGalleryArgs":{"type":"object","properties":{"pro":{"type":"string"},"salonId":{"anyOf":[{"type":"string"},{"type":"number"}]},"page":{"type":"number"}},"additionalProperties":true},"StyleseatJoinWaitlistArgs":{"type":"object","properties":{"pro":{"type":"string"},"serviceIds":{"type":"array","items":{"type":"number"}},"note":{"type":"string"}},"required":["pro","serviceIds"],"additionalProperties":true},"StyleseatLeaveReviewArgs":{"type":"object","properties":{"pro":{"type":"string"},"feedbackToken":{"type":"string"},"numStars":{"type":"number"},"reviewText":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}},"required":["pro","feedbackToken","numStars","reviewText"],"additionalProperties":true},"StyleseatMyAppointmentsArgs":{"type":"object","properties":{"completedOnly":{"type":"boolean"},"page":{"type":"number"},"size":{"type":"number"}},"additionalProperties":true},"StyleseatRescheduleArgs":{"type":"object","properties":{"id":{"type":"number"},"pro":{"type":"string"},"serviceIds":{"type":"array","items":{"type":"number"}},"date":{"type":"string"},"startTime":{"type":"string"}},"required":["id","pro","serviceIds","date","startTime"],"additionalProperties":true},"StyleseatReviewsArgs":{"type":"object","properties":{"pro":{"type":"string"},"pinnedOnly":{"type":"boolean"}},"required":["pro"],"additionalProperties":true},"StyleseatSearchArgs":{"type":"object","properties":{"query":{"type":"string"},"near":{"type":"string"},"limit":{"type":"number"}},"required":["query","near"],"additionalProperties":true},"StyleseatUpdateProfileArgs":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"}},"additionalProperties":true}}}}