{"items":[{"type":"link","label":"Setmore API","link":"/","routeSlug":"/","content":{"contentType":"overview","meta":{"name":"Setmore API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Setmore API (v2)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":1,"id":"section/getting-started"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Getting Started"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Setmore is an appointment scheduling platform that lets you book customer appointments, choose from available services, and manage appointments across multiple staff calendars under one account. This API provides the Setmore functions you need to build tools and integrations, from creating bookings and fetching available slots to managing services, categories, working hours, and staff and customer contacts."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/getting-started"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/getting-started/request-access"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Request access"},"children":[],"type":"text"}],"type":"strong"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To request access to the API, first make sure you've already signed up for a Setmore Pro account. Then send an email to api@setmore.com and include the following information:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Your Name"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Email address that's registered to your "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Setmore account"},"children":[],"type":"text"}],"type":"strong"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A brief description of what you'd like to use the API for"},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/getting-started/request-access"}],"sectionId":"/section/getting-started/request-access"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":4,"id":"section/getting-started/what-you-can-build"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"What you can build"},"children":[],"type":"text"}],"type":"strong"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The Setmore API enables you to build custom booking flows, retrieve calendar schedules, and manage customer and staff contacts. With this API, your integration can:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Manage Bookings:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Create, update, fetch, and delete appointments, group class sessions, and events, and add or remove customers on a class session."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve Availability:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Query bookable time slots for a staff member and service, check seat availability for upcoming class sessions, and read staff working hours."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Synchronize Services & Categories:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Create, update, and list services and categories, and assign staff members to services."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Manage Contacts:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Read staff contacts, and create, update, delete, and bulk-import customer contacts."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/getting-started/what-you-can-build"}],"sectionId":"/section/getting-started/what-you-can-build"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":4,"id":"section/getting-started/can-i-sell-my-integration"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Can I sell my integration?"},"children":[],"type":"text"}],"type":"strong"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Currently, no. We do not have a marketplace to sell or share integrations at this time."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/getting-started/can-i-sell-my-integration"}],"sectionId":"/section/getting-started/can-i-sell-my-integration"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":4,"id":"section/getting-started/need-help"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Need help?"},"children":[],"type":"text"}],"type":"strong"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Developer & Setmore API Support: Send an email to api@setmore.com."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"General Inquiries: Reach out to us at help@setmore.com."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Upgrading from v1?"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" See the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/changelog"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Changelog"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for what changed in v2 and how to migrate."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]}],"sectionId":"/section/getting-started/need-help"}],"sectionId":"/section/getting-started/need-help"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/getting-started/response-envelope"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response envelope"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"All responses share one envelope:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Success (single resource): "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ \"data\": { ... } }"},"children":[],"type":"code"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Success (list): "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ \"data\": [ ... ], \"cursor\": \"...\" }"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cursor"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"omitted when there is no next page."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Error (any non-2xx): "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ \"errors\": [ { \"code\": \"...\", \"message\": \"...\" } ] }"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This is always an array, even for a single error, e.g.:"},"children":[],"type":"text"},{"$$mdtype":"Node","attributes":{"content":"{\n  \"errors\": [\n    { \"code\": \"resource_not_found\", \"message\": \"The requested resource does not exist.\" }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"{\n  \"errors\": [\n    { \"code\": \"resource_not_found\", \"message\": \"The requested resource does not exist.\" }\n  ]\n}\n"},"children":[],"type":"text"}],"type":"fence"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/getting-started/response-envelope"}],"sectionId":"/section/getting-started/response-envelope"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/getting-started/error-codes"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Error codes"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Code"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Message"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"server_error"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generic server error."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"client_error"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generic client error."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"resource_not_found"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The requested resource does not exist."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The bearer token has expired."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"No "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials were found on the request."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"unsupported"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The operation is not supported."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required parameter was not supplied."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A parameter's value is invalid."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"action_forbidden"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The action is not authorized for this merchant."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"out_of_range"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A range or count is outside what is allowed (e.g. a slots date range over 7 days, or a booking's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"consumer_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" count)."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"resource_conflict"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The request conflicts with the current state of the resource."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"payload_too_large"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A value exceeded the allowed size limit."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"sectionId":"/section/getting-started/error-codes"}],"sectionId":"/section/getting-started/error-codes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/getting-started/time-standards"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Time standards"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Every date and time sent to or returned by the API is an"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":":"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ss"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" followed by an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"offset"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", which is either "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (UTC)"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"or a numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"-05:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The offset is required."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" A time without one is rejected, and fractions"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"of a second are not supported, so send whole seconds."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An offset is not a time zone."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T00:30:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T08:30:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. Read the offset in a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"value rather than assuming it is UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Requests"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" accept "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or any numeric offset."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Responses"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" differ by endpoint, so check the field:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Where"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Offset returned"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bookings and events ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"created_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"UTC, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". A time sent with an offset comes back as the same moment in UTC."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T00:30:00Z"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Available slots ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /slots"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The offset of the requested "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Asia/Singapore"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or another offset for other zones. It changes with daylight saving time."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T08:30:00+08:00"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Class sessions ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /slots/class/{class-key}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"UTC, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The requested "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" only decides which day a session is listed under."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-01-20T09:00:00Z"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/getting-started/time-standards"}],"sectionId":"/section/getting-started/time-standards"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/getting-started/rate-limiting"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Rate limiting"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To ensure high availability and consistent performance, the Setmore API"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"is subject to rate limiting. Usage is monitored continuously. While"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"standard traffic limits apply, Setmore reserves the right to dynamically"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"adjust or restrict request thresholds per minute based on system health"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"and client consumption patterns. If your application exceeds these"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"thresholds, the API returns an HTTP "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" response."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/getting-started/rate-limiting"}],"sectionId":"/section/getting-started/rate-limiting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/getting-started/authentication"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authentication"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Every request must be authenticated with an access token, sent as a bearer"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token. When your access request is approved, the Setmore team provisions a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"permanent refresh token and sends it to you by email. Use the refresh token"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"to generate access tokens with the token endpoint below."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keep your refresh token secret. Store it securely on your server and never"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expose it in client side code."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/getting-started/authentication"}],"sectionId":"/section/getting-started/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/getting-started/1.-exchange-your-refresh-token"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"1. Exchange your refresh token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Send a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" request to exchange your refresh token for an access token:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"GET https://developer.setmore.com/api/v2/o/oauth2/token?refreshToken={your_refresh_token}\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"GET https://developer.setmore.com/api/v2/o/oauth2/token?refreshToken={your_refresh_token}\n"},"children":[],"type":"text"}],"type":"fence"}]}],"sectionId":"/section/getting-started/1.-exchange-your-refresh-token"}],"sectionId":"/section/getting-started/1.-exchange-your-refresh-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/getting-started/2.-read-the-token-response"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2. Read the token response"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A successful exchange returns the access token and its details:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"{\n  \"response\": true,\n  \"data\": {\n    \"token\": {\n      \"access_token\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n      \"token_type\": \"BEARER\",\n      \"expires_in\": 604799,\n      \"user_id\": \"XXXXXXXXXX-XXXXXXXXXX-XXXXXXXXXX\"\n    }\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"{\n  \"response\": true,\n  \"data\": {\n    \"token\": {\n      \"access_token\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n      \"token_type\": \"BEARER\",\n      \"expires_in\": 604799,\n      \"user_id\": \"XXXXXXXXXX-XXXXXXXXXX-XXXXXXXXXX\"\n    }\n  }\n}\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Field"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Description"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"access_token"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The bearer token to send with your API requests."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_type"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Always "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"BEARER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expires_in"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"How long the access token is valid, in seconds."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"user_id"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The id of the account the token belongs to."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"sectionId":"/section/getting-started/2.-read-the-token-response"}],"sectionId":"/section/getting-started/2.-read-the-token-response"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/getting-started/3.-send-the-access-token-with-your-requests"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"3. Send the access token with your requests"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add the access token to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header of every request:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"Authorization: Bearer {access_token}\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"Authorization: Bearer {access_token}\n"},"children":[],"type":"text"}],"type":"fence"}]}],"sectionId":"/section/getting-started/3.-send-the-access-token-with-your-requests"}],"sectionId":"/section/getting-started/3.-send-the-access-token-with-your-requests"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/getting-started/token-lifespan"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Token lifespan"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Access tokens are short lived and expire after the number of seconds given"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"expires_in"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Track the expiry time in your integration and call the token"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"endpoint again to get a new access token before the current one expires."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"A request made with an expired token fails with the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" error"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"code."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/getting-started/token-lifespan"}],"sectionId":"/section/getting-started/token-lifespan"}]}]}},{"type":"group","label":"Getting Started","link":"/section/getting-started","routeSlug":"/section/getting-started","items":[{"type":"link","label":"Request access","link":"/section/getting-started/request-access","routeSlug":"/section/getting-started/request-access","content":null},{"type":"link","label":"What you can build","link":"/section/getting-started/what-you-can-build","routeSlug":"/section/getting-started/what-you-can-build","content":null},{"type":"link","label":"Can I sell my integration?","link":"/section/getting-started/can-i-sell-my-integration","routeSlug":"/section/getting-started/can-i-sell-my-integration","content":null},{"type":"link","label":"Need help?","link":"/section/getting-started/need-help","routeSlug":"/section/getting-started/need-help","content":null},{"type":"link","label":"Response envelope","link":"/section/getting-started/response-envelope","routeSlug":"/section/getting-started/response-envelope","content":null},{"type":"link","label":"Error codes","link":"/section/getting-started/error-codes","routeSlug":"/section/getting-started/error-codes","content":null},{"type":"link","label":"Time standards","link":"/section/getting-started/time-standards","routeSlug":"/section/getting-started/time-standards","content":null},{"type":"link","label":"Rate limiting","link":"/section/getting-started/rate-limiting","routeSlug":"/section/getting-started/rate-limiting","content":null},{"type":"link","label":"Authentication","link":"/section/getting-started/authentication","routeSlug":"/section/getting-started/authentication","content":null},{"type":"link","label":"1. Exchange your refresh token","link":"/section/getting-started/1.-exchange-your-refresh-token","routeSlug":"/section/getting-started/1.-exchange-your-refresh-token","content":null},{"type":"link","label":"2. Read the token response","link":"/section/getting-started/2.-read-the-token-response","routeSlug":"/section/getting-started/2.-read-the-token-response","content":null},{"type":"link","label":"3. Send the access token with your requests","link":"/section/getting-started/3.-send-the-access-token-with-your-requests","routeSlug":"/section/getting-started/3.-send-the-access-token-with-your-requests","content":null},{"type":"link","label":"Token lifespan","link":"/section/getting-started/token-lifespan","routeSlug":"/section/getting-started/token-lifespan","content":null}],"content":null},{"type":"group","label":"Bookings","link":"/bookings","routeSlug":"/bookings","items":[{"type":"link","label":"Booking","link":"/bookings/booking","routeSlug":"/bookings/booking","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Booking"},"seo":{"title":"Booking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Booking"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/Booking"}]}]}]}},{"type":"link","label":"BookingLocation","link":"/bookings/bookinglocation","routeSlug":"/bookings/bookinglocation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"BookingLocation"},"seo":{"title":"BookingLocation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BookingLocation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/BookingLocation"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/BookingLocation"}]}]}]}},{"label":"Create a booking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/createbooking","routeSlug":"/bookings/createbooking","metadata":{"seo":{"title":"Create a booking","description":"Creates a booking for the given staff member(s), customer(s), and service(s)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBooking","name":"Create a booking","isWebhook":false,"pointer":"/paths/~1bookings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a booking","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a booking for the given staff member(s), customer(s), and service(s)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookingRequest"}},"schemaId":"components/schemas/BookingRequest","pointer":"/paths/~1bookings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bookings","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BookingRequest"}},"responseCodes":["200","400","401","413","500"],"pointer":"/bookings","href":"/bookings/createbooking","openApiOperationId":"createBooking","summary":"Create a booking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/BookingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Booking created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse","exampleIds":["paths/~1bookings/post/responses/200/content/application~1json/examples/created"]}},"schemaId":"components/schemas/BookingResponse","exampleIds":["paths/~1bookings/post/responses/200/content/application~1json/examples/created"]},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: a required field is missing ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), a value is invalid"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), or the number of customers is not allowed for the booking type"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"out_of_range"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/400/content/application~1json/examples/typeMismatch","paths/~1bookings/post/responses/400/content/application~1json/examples/customerCount"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/400/content/application~1json/examples/typeMismatch","paths/~1bookings/post/responses/400/content/application~1json/examples/customerCount"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings/post/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings/post/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingResponse","exampleIds":["paths/~1bookings/post/responses/200/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse","exampleIds":["paths/~1bookings/post/responses/200/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/400/content/application~1json/examples/typeMismatch","paths/~1bookings/post/responses/400/content/application~1json/examples/customerCount"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/400/content/application~1json/examples/typeMismatch","paths/~1bookings/post/responses/400/content/application~1json/examples/customerCount"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings/post/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings/post/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings/post/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/createbooking"}],"panels":[]}]},"httpPath":"/bookings"},{"label":"Create an event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/createevent","routeSlug":"/bookings/createevent","metadata":{"seo":{"title":"Create an event","description":"Creates an event: a calendar entry for a staff member that is not tied to a service. It takesa smaller payload than a booking, and the response is the same booking object with type setto EVENT and service_id, cost and label empty."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEvent","name":"Create an event","isWebhook":false,"pointer":"/paths/~1bookings~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates an event: a calendar entry for a staff member that is not tied to a service. It takes"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"a smaller payload than a booking, and the response is the same booking object with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" set"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"EVENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cost"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" empty."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventRequest"}},"schemaId":"components/schemas/EventRequest","pointer":"/paths/~1bookings~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bookings/events","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EventRequest"}},"responseCodes":["200","400","401","405","413","500"],"pointer":"/bookings/events","href":"/bookings/createevent","openApiOperationId":"createEvent","summary":"Create an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/EventRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse","exampleIds":["paths/~1bookings~1events/post/responses/200/content/application~1json/examples/created"]}},"schemaId":"components/schemas/BookingResponse","exampleIds":["paths/~1bookings~1events/post/responses/200/content/application~1json/examples/created"]},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: a required field is missing ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), a value is invalid"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), or there are more than 10 customers ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"out_of_range"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope"}},"schemaId":"components/schemas/ErrorsEnvelope"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1events/post/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1events/post/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"405","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The request contains a value for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cost"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". An event does not"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"support them, so remove them from the request."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/405/content/application~1json/examples/unsupportedFields"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/405/content/application~1json/examples/unsupportedFields"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1events/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingResponse","exampleIds":["paths/~1bookings~1events/post/responses/200/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse","exampleIds":["paths/~1bookings~1events/post/responses/200/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1events/post/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1events/post/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"405","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/405/content/application~1json/examples/unsupportedFields"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/405/content/application~1json/examples/unsupportedFields"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events/post/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/createevent"}],"panels":[]}]},"httpPath":"/bookings/events"},{"label":"Update an event","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/updateevent","routeSlug":"/bookings/updateevent","metadata":{"seo":{"title":"Update an event","description":"Updates the event identified by the id in the path. If the request body also contains an id, it must match the path id; otherwise the request is rejected with 400 (parameter_invalid, \"Invalid id\").Only events can be updated here. To update an appointment or a class session, useUpdate a booking."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEvent","name":"Update an event","isWebhook":false,"pointer":"/paths/~1bookings~1events~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the event identified by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the path. If the request body also contains an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", it must match the path "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; otherwise the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", \"Invalid id\")."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Only events can be updated here. To update an appointment or a class session, use"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/updatebooking"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update a booking"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An update does not change the event's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"created_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". If "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"source"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is left out, the stored "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"source"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is kept."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video meeting ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"):"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keep the existing meeting unchanged:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" send the event's existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" back as it was"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"returned ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"video_type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"link"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), or leave "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" out."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove the meeting:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" send an empty object, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"location\": {}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generate a new meeting:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" send "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type: [\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"video_type: [{ \"type\": \"google-meet\" }]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Providing the provider "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is enough, and the link is generated."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1bookings~1events~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventUpdateRequest"}},"schemaId":"components/schemas/EventUpdateRequest","pointer":"/paths/~1bookings~1events~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/bookings/events/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"bk_123456","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EventUpdateRequest"}},"responseCodes":["200","400","401","404","405","413","500"],"pointer":"/bookings/events/{id}","href":"/bookings/updateevent","openApiOperationId":"updateEvent","summary":"Update an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/EventUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}},"schemaId":"components/schemas/BookingResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: a required field is missing ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), a value is invalid"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), or there are more than 10 customers ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"out_of_range"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope"}},"schemaId":"components/schemas/ErrorsEnvelope"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/notFound"]},{"code":"405","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The request contains a value for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cost"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", which an event does not"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"support, or the booking with this id is an appointment or a class session, not an event."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/405/content/application~1json/examples/unsupportedFields"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/405/content/application~1json/examples/unsupportedFields"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1events~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/notFound"]}}},{"code":"405","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/405/content/application~1json/examples/unsupportedFields"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/405/content/application~1json/examples/unsupportedFields"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1events~1{id}/put/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/updateevent"}],"panels":[]}]},"httpPath":"/bookings/events/{id}"},{"label":"Fetch a booking by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/getbookingbyid","routeSlug":"/bookings/getbookingbyid","metadata":{"seo":{"title":"Fetch a booking by id","description":"Fetch a booking by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBookingById","name":"Fetch a booking by id","isWebhook":false,"pointer":"/paths/~1bookings~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a booking by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1bookings~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bookings/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"bk_123456","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/bookings/{id}","href":"/bookings/getbookingbyid","openApiOperationId":"getBookingById","summary":"Fetch a booking by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Booking fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}},"schemaId":"components/schemas/BookingResponse"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: the authenticated merchant does not own this resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/getbookingbyid"}],"panels":[]}]},"httpPath":"/bookings/{id}"},{"label":"Update a booking","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/updatebooking","routeSlug":"/bookings/updatebooking","metadata":{"seo":{"title":"Update a booking","description":"Updates the booking identified by the id in the path. If the request body also contains an id, it must match the path id; otherwise the request is rejected with 400 (parameter_invalid, \"Invalid id\")."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBooking","name":"Update a booking","isWebhook":false,"pointer":"/paths/~1bookings~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a booking","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the booking identified by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the path. If the request body also contains an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", it must match the path "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; otherwise the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", \"Invalid id\")."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video meeting ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"):"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keep the existing meeting unchanged:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" send the booking's existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" back as it was"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"returned ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"video_type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"link"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove the meeting:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" send an empty object, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"location\": {}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generate a new meeting:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" send "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type: [\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"video_type: [{ \"type\": \"google-meet\" }]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Providing the provider "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is enough, and the link is generated."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1bookings~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookingUpdateRequest"}},"schemaId":"components/schemas/BookingUpdateRequest","pointer":"/paths/~1bookings~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/bookings/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"bk_123456","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BookingUpdateRequest"}},"responseCodes":["200","400","401","404","405","413","500"],"pointer":"/bookings/{id}","href":"/bookings/updatebooking","openApiOperationId":"updateBooking","summary":"Update a booking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/BookingUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookingUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Booking updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}},"schemaId":"components/schemas/BookingResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: a required field is missing ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), a value is invalid"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), or the number of customers is not allowed for the booking type"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"out_of_range"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/typeMismatch","paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/customerCount"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/typeMismatch","paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/customerCount"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/notFound"]},{"code":"405","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The booking is a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SESSION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (a group class) and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"consumer_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" differ from the customers"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"already in it. The customers of a session can't be changed by updating the booking. Use"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/addclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add a customer to a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/removeclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove a customer from a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" instead."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/405/content/application~1json/examples/sessionCustomersLocked"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/405/content/application~1json/examples/sessionCustomersLocked"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/typeMismatch","paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/customerCount"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/typeMismatch","paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/customerCount"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/notFound"]}}},{"code":"405","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/405/content/application~1json/examples/sessionCustomersLocked"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/405/content/application~1json/examples/sessionCustomersLocked"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/put/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/updatebooking"}],"panels":[]}]},"httpPath":"/bookings/{id}"},{"label":"Delete a booking","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/deletebooking","routeSlug":"/bookings/deletebooking","metadata":{"seo":{"title":"Delete a booking","description":"Delete a booking"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBooking","name":"Delete a booking","isWebhook":false,"pointer":"/paths/~1bookings~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a booking","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1bookings~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/bookings/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"bk_123456","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/bookings/{id}","href":"/bookings/deletebooking","openApiOperationId":"deleteBooking","summary":"Delete a booking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Booking deleted. Bookings are soft-deleted, so the booking is returned"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"with its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}},"schemaId":"components/schemas/BookingResponse"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/deletebooking"}],"panels":[]}]},"httpPath":"/bookings/{id}"},{"label":"Fetch bookings for a staff member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/getbookingsbystaff","routeSlug":"/bookings/getbookingsbystaff","metadata":{"seo":{"title":"Fetch bookings for a staff member","description":"Fetch bookings assigned to the staff member identified by {id}, within the given date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBookingsByStaff","name":"Fetch bookings for a staff member","isWebhook":false,"pointer":"/paths/~1bookings~1staffs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch bookings for a staff member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fetch bookings assigned to the staff member identified by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", within the given date range."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1","description":"Staff member id.","required":true}],"pointer":"/paths/~1bookings~1staffs~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_at","in":"query","schemaId":"schema_2","required":true},{"name":"end_at","in":"query","schemaId":"schema_3","required":true},{"name":"cursor","in":"query","schemaId":"schema_4","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page."},{"name":"limit","in":"query","schemaId":"schema_5"}],"pointer":"/paths/~1bookings~1staffs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bookings/staffs/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"staff_123456","schemaId":"schema_1"}],"query":[{"name":"start_at","in":"query","required":true,"example":"2026-01-20T00:00:00Z","schemaId":"schema_2"},{"name":"end_at","in":"query","required":true,"example":"2026-01-27T00:00:00Z","schemaId":"schema_3"},{"name":"cursor","in":"query","required":false,"example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9","schemaId":"schema_4"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/bookings/staffs/{id}","href":"/bookings/getbookingsbystaff","openApiOperationId":"getBookingsByStaff","summary":"Fetch bookings for a staff member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bookings fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingListResponse"}},"schemaId":"components/schemas/BookingListResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/required","paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/required","paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1staffs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/required","paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/required","paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/getbookingsbystaff"}],"panels":[]}]},"httpPath":"/bookings/staffs/{id}"},{"label":"Fetch bookings for a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/getbookingsbycustomer","routeSlug":"/bookings/getbookingsbycustomer","metadata":{"seo":{"title":"Fetch bookings for a customer","description":"Fetch bookings for the customer identified by {id}, within the given date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBookingsByCustomer","name":"Fetch bookings for a customer","isWebhook":false,"pointer":"/paths/~1bookings~1customers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch bookings for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fetch bookings for the customer identified by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", within the given date range."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_6","description":"Customer id.","required":true}],"pointer":"/paths/~1bookings~1customers~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_at","in":"query","schemaId":"schema_2","required":true},{"name":"end_at","in":"query","schemaId":"schema_3","required":true},{"name":"cursor","in":"query","schemaId":"schema_4","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page."},{"name":"limit","in":"query","schemaId":"schema_5"}],"pointer":"/paths/~1bookings~1customers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bookings/customers/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cust_123456","schemaId":"schema_6"}],"query":[{"name":"start_at","in":"query","required":true,"example":"2026-01-20T00:00:00Z","schemaId":"schema_2"},{"name":"end_at","in":"query","required":true,"example":"2026-01-27T00:00:00Z","schemaId":"schema_3"},{"name":"cursor","in":"query","required":false,"example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9","schemaId":"schema_4"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/bookings/customers/{id}","href":"/bookings/getbookingsbycustomer","openApiOperationId":"getBookingsByCustomer","summary":"Fetch bookings for a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bookings fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingListResponse"}},"schemaId":"components/schemas/BookingListResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/required","paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/required","paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1customers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/required","paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/required","paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/getbookingsbycustomer"}],"panels":[]}]},"httpPath":"/bookings/customers/{id}"},{"label":"Add a customer to a class session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/addclassattendee","routeSlug":"/bookings/addclassattendee","metadata":{"seo":{"title":"Add a customer to a class session","description":"Books a customer into a class session and returns the updated session. Bothids are path parameters; the request has no body. The customer is reminded byemail and SMS. Session ids come from Fetch class slots."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addClassAttendee","name":"Add a customer to a class session","isWebhook":false,"pointer":"/paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a customer to a class session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Books a customer into a class session and returns the updated session. Both"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ids are path parameters; the request has no body. The customer is reminded by"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"email and SMS. Session ids come from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/slots/getclassslots"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fetch class slots"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"session-id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Id of the class session ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"session_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the class slots response)."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true},{"name":"customer-id","in":"path","schemaId":"schema_6","required":true}],"pointer":"/paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bookings/class/{session-id}/attendees/{customer-id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"session-id","in":"path","required":true,"example":"evt_123456","schemaId":"schema_7"},{"name":"customer-id","in":"path","required":true,"example":"cust_123456","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","409","500"],"pointer":"/bookings/class/{session-id}/attendees/{customer-id}","href":"/bookings/addclassattendee","openApiOperationId":"addClassAttendee","summary":"Add a customer to a class session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customer added. Returns the class session, whose "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"consumer_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" now include the customer."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}},"schemaId":"components/schemas/BookingResponse"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/notFound"]},{"code":"409","description":"The customer is already in the session, or the session is full.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/alreadyInSession","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/sessionFull"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/alreadyInSession","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/sessionFull"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/unknownId","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/notFound"]}}},{"code":"409","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/alreadyInSession","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/sessionFull"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/alreadyInSession","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/sessionFull"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/addclassattendee"}],"panels":[]}]},"httpPath":"/bookings/class/{session-id}/attendees/{customer-id}"},{"label":"Remove a customer from a class session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/bookings/removeclassattendee","routeSlug":"/bookings/removeclassattendee","metadata":{"seo":{"title":"Remove a customer from a class session","description":"Removes a customer from a class session and returns the updated session. Both ids are path parameters; the request has no body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeClassAttendee","name":"Remove a customer from a class session","isWebhook":false,"pointer":"/paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a customer from a class session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a customer from a class session and returns the updated session. Both\nids are path parameters; the request has no body.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"session-id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Id of the class session ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"session_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the class slots response)."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true},{"name":"customer-id","in":"path","schemaId":"schema_6","required":true}],"pointer":"/paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/bookings/class/{session-id}/attendees/{customer-id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"session-id","in":"path","required":true,"example":"evt_123456","schemaId":"schema_7"},{"name":"customer-id","in":"path","required":true,"example":"cust_123456","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/bookings/class/{session-id}/attendees/{customer-id}","href":"/bookings/removeclassattendee","openApiOperationId":"removeClassAttendee","summary":"Remove a customer from a class session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customer removed. Returns the class session, whose "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"consumer_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" no longer include the customer."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}},"schemaId":"components/schemas/BookingResponse"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"The session does not exist, or the customer is not in the session.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/removeclassattendee"}],"panels":[]}]},"httpPath":"/bookings/class/{session-id}/attendees/{customer-id}"}],"content":{"contentType":"group","meta":{"name":"Bookings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bookings","showPageActions":true},{"nodeType":"markdoc","content":"Create, fetch, update, and delete bookings; list bookings by staff or customer."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Booking","link":"/bookings/booking","deprecated":false},{"title":"BookingLocation","link":"/bookings/bookinglocation","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bookings","summary":"Create a booking","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bookings/createbooking","deprecated":false},{"title":"/bookings/events","summary":"Create an event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bookings/createevent","deprecated":false},{"title":"/bookings/events/{id}","summary":"Update an event","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bookings/updateevent","deprecated":false},{"title":"/bookings/{id}","summary":"Fetch a booking by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bookings/getbookingbyid","deprecated":false},{"title":"/bookings/{id}","summary":"Update a booking","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bookings/updatebooking","deprecated":false},{"title":"/bookings/{id}","summary":"Delete a booking","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bookings/deletebooking","deprecated":false},{"title":"/bookings/staffs/{id}","summary":"Fetch bookings for a staff member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bookings/getbookingsbystaff","deprecated":false},{"title":"/bookings/customers/{id}","summary":"Fetch bookings for a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bookings/getbookingsbycustomer","deprecated":false},{"title":"/bookings/class/{session-id}/attendees/{customer-id}","summary":"Add a customer to a class session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bookings/addclassattendee","deprecated":false},{"title":"/bookings/class/{session-id}/attendees/{customer-id}","summary":"Remove a customer from a class session","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bookings/removeclassattendee","deprecated":false}]}]}]}]}},{"type":"group","label":"Slots","link":"/slots","routeSlug":"/slots","items":[{"type":"link","label":"Slots","link":"/slots/slots","routeSlug":"/slots/slots","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Slots"},"seo":{"title":"Slots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Slots","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Slots"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/Slots"}]}]}]}},{"type":"link","label":"ClassSlots","link":"/slots/classslots","routeSlug":"/slots/classslots","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ClassSlots"},"seo":{"title":"ClassSlots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ClassSlots","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ClassSlots"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/ClassSlots"}]}]}]}},{"label":"Fetch slots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/slots/getslots","routeSlug":"/slots/getslots","metadata":{"seo":{"title":"Fetch slots","description":"Returns bookable time slots for a staff member/service within the given date range.The date range (end_at - start_at) must not exceed 7 days."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSlots","name":"Fetch slots","isWebhook":false,"pointer":"/paths/~1slots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch slots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns bookable time slots for a staff member/service within the given date range."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The date range ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") must not exceed 7 days."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_id","in":"query","schemaId":"schema_8","required":true},{"name":"provider_id","in":"query","schemaId":"schema_9","description":"Staff member id.","required":true},{"name":"duration","in":"query","schemaId":"schema_10","description":"Meeting duration in minutes.","required":true},{"name":"start_at","in":"query","schemaId":"schema_11","required":true},{"name":"end_at","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Must be within 7 days of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true},{"name":"timezone","in":"query","schemaId":"schema_13","required":true},{"name":"slot_limit","in":"query","schemaId":"schema_14"},{"name":"double_booking","in":"query","schemaId":"schema_15"},{"name":"working_hours","in":"query","schemaId":"schema_15"}],"pointer":"/paths/~1slots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/slots","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"account_id","in":"query","required":true,"example":"acc_123456","schemaId":"schema_8"},{"name":"provider_id","in":"query","required":true,"example":"provider_123456","schemaId":"schema_9"},{"name":"duration","in":"query","required":true,"example":30,"schemaId":"schema_10"},{"name":"start_at","in":"query","required":true,"example":"2026-11-19T00:00:00+08:00","schemaId":"schema_11"},{"name":"end_at","in":"query","required":true,"example":"2026-11-25T00:00:00+08:00","schemaId":"schema_12"},{"name":"timezone","in":"query","required":true,"example":"Asia/Singapore","schemaId":"schema_13"},{"name":"slot_limit","in":"query","required":false,"example":15,"schemaId":"schema_14"},{"name":"double_booking","in":"query","required":false,"example":false,"schemaId":"schema_15"},{"name":"working_hours","in":"query","required":false,"example":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/slots","href":"/slots/getslots","openApiOperationId":"getSlots","summary":"Fetch slots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Slots fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SlotsResponse"}},"schemaId":"components/schemas/SlotsResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Invalid request: a required field is missing, the date range exceeds 7 days, or"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not a staff member of the account."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/400/content/application~1json/examples/rangeExceeded","paths/~1slots/get/responses/400/content/application~1json/examples/unknownStaff"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/400/content/application~1json/examples/rangeExceeded","paths/~1slots/get/responses/400/content/application~1json/examples/unknownStaff"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1slots/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1slots/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1slots/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SlotsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SlotsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/400/content/application~1json/examples/rangeExceeded","paths/~1slots/get/responses/400/content/application~1json/examples/unknownStaff"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/400/content/application~1json/examples/rangeExceeded","paths/~1slots/get/responses/400/content/application~1json/examples/unknownStaff"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1slots/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1slots/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/slots/getslots"}],"panels":[]}]},"httpPath":"/slots"},{"label":"Fetch class slots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/slots/getclassslots","routeSlug":"/slots/getclassslots","metadata":{"seo":{"title":"Fetch class slots","description":"Returns the upcoming sessions of a class (a service of type CLASS) with theirseat availability, grouped by day. Public counterpart of the class inventory."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClassSlots","name":"Fetch class slots","isWebhook":false,"pointer":"/paths/~1slots~1class~1{class-key}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch class slots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns the upcoming sessions of a class (a service of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") with their"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"seat availability, grouped by day. Public counterpart of the class inventory."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A class that has no upcoming sessions, including one that has no sessions yet, returns "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"200"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an empty"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"days"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" map. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"404"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is returned only when the id is not an active class of your account: it is unknown, deleted,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"a service rather than a class, or belongs to another account."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"class-key","in":"path","schemaId":"schema_16","description":"Id of the class.","required":true}],"pointer":"/paths/~1slots~1class~1{class-key}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timezone","in":"query","schemaId":"schema_17","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Time zone used to group sessions into days. Session times are always returned in UTC ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"); this only decides"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"which day each session is listed under."},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1slots~1class~1{class-key}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/slots/class/{class-key}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"class-key","in":"path","required":true,"example":"svc_123456","schemaId":"schema_16"}],"query":[{"name":"timezone","in":"query","required":false,"example":"America/New_York","schemaId":"schema_17"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/slots/class/{class-key}","href":"/slots/getclassslots","openApiOperationId":"getClassSlots","summary":"Fetch class slots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Class slots fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClassSlotsResponse"}},"schemaId":"components/schemas/ClassSlotsResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Invalid "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/400/content/application~1json/examples/invalidTimezone"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/400/content/application~1json/examples/invalidTimezone"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/unknownId","paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/unknownId","paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1slots~1class~1{class-key}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClassSlotsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClassSlotsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/400/content/application~1json/examples/invalidTimezone"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/400/content/application~1json/examples/invalidTimezone"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/unknownId","paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/unknownId","paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1slots~1class~1{class-key}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/slots/getclassslots"}],"panels":[]}]},"httpPath":"/slots/class/{class-key}"}],"content":{"contentType":"group","meta":{"name":"Slots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Slots","showPageActions":true},{"nodeType":"markdoc","content":"Fetch bookable time slots for a staff member/service within a date range, and upcoming class sessions with seat availability."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Slots","link":"/slots/slots","deprecated":false},{"title":"ClassSlots","link":"/slots/classslots","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/slots","summary":"Fetch slots","prefix":{"name":"get","color":"get"},"badges":[],"link":"/slots/getslots","deprecated":false},{"title":"/slots/class/{class-key}","summary":"Fetch class slots","prefix":{"name":"get","color":"get"},"badges":[],"link":"/slots/getclassslots","deprecated":false}]}]}]}]}},{"type":"group","label":"Categories","link":"/categories","routeSlug":"/categories","items":[{"type":"link","label":"Category","link":"/categories/category","routeSlug":"/categories/category","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Category"},"seo":{"title":"Category"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Category","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Category"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/Category"}]}]}]}},{"label":"Fetch categories by merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/categories/getcategoriesbymerchant","routeSlug":"/categories/getcategoriesbymerchant","metadata":{"seo":{"title":"Fetch categories by merchant","description":"Fetch categories by merchant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCategoriesByMerchant","name":"Fetch categories by merchant","isWebhook":false,"pointer":"/paths/~1categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch categories by merchant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_4","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page."},{"name":"limit","in":"query","schemaId":"schema_5"}],"pointer":"/paths/~1categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/categories","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9","schemaId":"schema_4"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/categories","href":"/categories/getcategoriesbymerchant","openApiOperationId":"getCategoriesByMerchant","summary":"Fetch categories by merchant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Categories fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryListResponse"}},"schemaId":"components/schemas/CategoryListResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/400/content/application~1json/examples/required","paths/~1categories/get/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/400/content/application~1json/examples/required","paths/~1categories/get/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1categories/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CategoryListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/400/content/application~1json/examples/required","paths/~1categories/get/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/400/content/application~1json/examples/required","paths/~1categories/get/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/getcategoriesbymerchant"}],"panels":[]}]},"httpPath":"/categories"},{"label":"Create a category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/categories/createcategory","routeSlug":"/categories/createcategory","metadata":{"seo":{"title":"Create a category","description":"Create a category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCategory","name":"Create a category","isWebhook":false,"pointer":"/paths/~1categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CategoryRequest"}},"schemaId":"components/schemas/CategoryRequest","pointer":"/paths/~1categories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/categories","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CategoryRequest"}},"responseCodes":["200","400","401","409","413","500"],"pointer":"/categories","href":"/categories/createcategory","openApiOperationId":"createCategory","summary":"Create a category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/CategoryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CategoryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Category created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryResponse"}},"schemaId":"components/schemas/CategoryResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/400/content/application~1json/examples/required","paths/~1categories/post/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/400/content/application~1json/examples/required","paths/~1categories/post/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories/post/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories/post/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"409","description":"Another category in the account already uses this title. Titles are compared ignoring case and surrounding spaces.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/409/content/application~1json/examples/duplicateTitle"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/409/content/application~1json/examples/duplicateTitle"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1categories/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CategoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/400/content/application~1json/examples/required","paths/~1categories/post/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/400/content/application~1json/examples/required","paths/~1categories/post/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories/post/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories/post/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"409","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/409/content/application~1json/examples/duplicateTitle"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/409/content/application~1json/examples/duplicateTitle"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories/post/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/createcategory"}],"panels":[]}]},"httpPath":"/categories"},{"label":"Fetch a category by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/categories/getcategorybyid","routeSlug":"/categories/getcategorybyid","metadata":{"seo":{"title":"Fetch a category by id","description":"Fetch a category by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCategoryById","name":"Fetch a category by id","isWebhook":false,"pointer":"/paths/~1categories~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a category by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","required":true}],"pointer":"/paths/~1categories~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/categories/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cat_123456","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/categories/{id}","href":"/categories/getcategorybyid","openApiOperationId":"getCategoryById","summary":"Fetch a category by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Category fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryResponse"}},"schemaId":"components/schemas/CategoryResponse"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: the authenticated merchant does not own this resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1categories~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CategoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/getcategorybyid"}],"panels":[]}]},"httpPath":"/categories/{id}"},{"label":"Update a category","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/categories/updatecategory","routeSlug":"/categories/updatecategory","metadata":{"seo":{"title":"Update a category","description":"The id in the path is authoritative, and any id in the request body is ignored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCategory","name":"Update a category","isWebhook":false,"pointer":"/paths/~1categories~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the path is authoritative, and any "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the request body is ignored."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","required":true}],"pointer":"/paths/~1categories~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CategoryRequest"}},"schemaId":"components/schemas/CategoryRequest","pointer":"/paths/~1categories~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/categories/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cat_123456","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CategoryRequest"}},"responseCodes":["200","400","401","404","409","413","500"],"pointer":"/categories/{id}","href":"/categories/updatecategory","openApiOperationId":"updateCategory","summary":"Update a category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/CategoryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CategoryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Category updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryResponse"}},"schemaId":"components/schemas/CategoryResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/required","paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/required","paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/notFound"]},{"code":"409","description":"Another category in the account already uses this title. Titles are compared ignoring case and surrounding spaces.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/409/content/application~1json/examples/duplicateTitle"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/409/content/application~1json/examples/duplicateTitle"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1categories~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CategoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/required","paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/required","paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/notFound"]}}},{"code":"409","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/409/content/application~1json/examples/duplicateTitle"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/409/content/application~1json/examples/duplicateTitle"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/put/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/updatecategory"}],"panels":[]}]},"httpPath":"/categories/{id}"},{"label":"Delete a category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/categories/deletecategory","routeSlug":"/categories/deletecategory","metadata":{"seo":{"title":"Delete a category","description":"Delete a category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCategory","name":"Delete a category","isWebhook":false,"pointer":"/paths/~1categories~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","required":true}],"pointer":"/paths/~1categories~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/categories/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"cat_123456","schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","404","500"],"pointer":"/categories/{id}","href":"/categories/deletecategory","openApiOperationId":"deleteCategory","summary":"Delete a category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Category deleted. No content returned."},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1categories~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1categories~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/deletecategory"}],"panels":[]}]},"httpPath":"/categories/{id}"}],"content":{"contentType":"group","meta":{"name":"Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Categories","showPageActions":true},{"nodeType":"markdoc","content":"Create, fetch, update, and delete categories."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Category","link":"/categories/category","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/categories","summary":"Fetch categories by merchant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categories/getcategoriesbymerchant","deprecated":false},{"title":"/categories","summary":"Create a category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/categories/createcategory","deprecated":false},{"title":"/categories/{id}","summary":"Fetch a category by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categories/getcategorybyid","deprecated":false},{"title":"/categories/{id}","summary":"Update a category","prefix":{"name":"put","color":"put"},"badges":[],"link":"/categories/updatecategory","deprecated":false},{"title":"/categories/{id}","summary":"Delete a category","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/categories/deletecategory","deprecated":false}]}]}]}]}},{"type":"group","label":"Services","link":"/services","routeSlug":"/services","items":[{"type":"link","label":"Service","link":"/services/service","routeSlug":"/services/service","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Service"},"seo":{"title":"Service"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Service"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/Service"}]}]}]}},{"type":"link","label":"ServiceLocation","link":"/services/servicelocation","routeSlug":"/services/servicelocation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ServiceLocation"},"seo":{"title":"ServiceLocation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ServiceLocation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ServiceLocation"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/ServiceLocation"}]}]}]}},{"label":"Fetch services by merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/getservicesbymerchant","routeSlug":"/services/getservicesbymerchant","metadata":{"seo":{"title":"Fetch services by merchant","description":"Fetch services by merchant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServicesByMerchant","name":"Fetch services by merchant","isWebhook":false,"pointer":"/paths/~1services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch services by merchant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"provider_id","in":"query","schemaId":"schema_9","description":"Filter to services bookable with this staff member."},{"name":"is_deleted","in":"query","schemaId":"schema_15"},{"name":"cursor","in":"query","schemaId":"schema_4","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page."},{"name":"limit","in":"query","schemaId":"schema_5"}],"pointer":"/paths/~1services/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/services","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"provider_id","in":"query","required":false,"example":"provider_123456","schemaId":"schema_9"},{"name":"is_deleted","in":"query","required":false,"example":false,"schemaId":"schema_15"},{"name":"cursor","in":"query","required":false,"example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9","schemaId":"schema_4"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/services","href":"/services/getservicesbymerchant","openApiOperationId":"getServicesByMerchant","summary":"Fetch services by merchant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Services fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceListResponse"}},"schemaId":"components/schemas/ServiceListResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/400/content/application~1json/examples/required","paths/~1services/get/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/400/content/application~1json/examples/required","paths/~1services/get/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1services/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/400/content/application~1json/examples/required","paths/~1services/get/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/400/content/application~1json/examples/required","paths/~1services/get/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/getservicesbymerchant"}],"panels":[]}]},"httpPath":"/services"},{"label":"Create a service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/createservice","routeSlug":"/services/createservice","metadata":{"seo":{"title":"Create a service","description":"Create a service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createService","name":"Create a service","isWebhook":false,"pointer":"/paths/~1services/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceRequest"}},"schemaId":"components/schemas/ServiceRequest","pointer":"/paths/~1services/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceRequest"}},"responseCodes":["200","400","401","413","500"],"pointer":"/services","href":"/services/createservice","openApiOperationId":"createService","summary":"Create a service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/ServiceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Service created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceResponse"}},"schemaId":"components/schemas/ServiceResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/400/content/application~1json/examples/required","paths/~1services/post/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/400/content/application~1json/examples/required","paths/~1services/post/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services/post/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services/post/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1services/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/400/content/application~1json/examples/required","paths/~1services/post/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/400/content/application~1json/examples/required","paths/~1services/post/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services/post/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services/post/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services/post/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/createservice"}],"panels":[]}]},"httpPath":"/services"},{"label":"Fetch a service by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/getservicebyid","routeSlug":"/services/getservicebyid","metadata":{"seo":{"title":"Fetch a service by id","description":"Fetch a service by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServiceById","name":"Fetch a service by id","isWebhook":false,"pointer":"/paths/~1services~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a service by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","required":true}],"pointer":"/paths/~1services~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/services/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"svc_123456","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/services/{id}","href":"/services/getservicebyid","openApiOperationId":"getServiceById","summary":"Fetch a service by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Service fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceResponse"}},"schemaId":"components/schemas/ServiceResponse"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: the authenticated merchant does not own this resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1services~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/getservicebyid"}],"panels":[]}]},"httpPath":"/services/{id}"},{"label":"Update a service","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/updateservice","routeSlug":"/services/updateservice","metadata":{"seo":{"title":"Update a service","description":"Updates the service identified by the id in the path. If the request body also contains an id, it mustmatch the path id; otherwise the request is rejected with 400 (parameter_invalid, \"Invalid id\")."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateService","name":"Update a service","isWebhook":false,"pointer":"/paths/~1services~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updates the service identified by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the path. If the request body also contains an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", it must"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"match the path "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; otherwise the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", \"Invalid id\")."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of a service cannot be changed. Send the service's existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; a different one is rejected"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). A "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" still needs at least one id in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","required":true}],"pointer":"/paths/~1services~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceRequest"}},"schemaId":"components/schemas/ServiceRequest","pointer":"/paths/~1services~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/services/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"svc_123456","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceRequest"}},"responseCodes":["200","400","401","404","413","500"],"pointer":"/services/{id}","href":"/services/updateservice","openApiOperationId":"updateService","summary":"Update a service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/ServiceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Service updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceResponse"}},"schemaId":"components/schemas/ServiceResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/400/content/application~1json/examples/required","paths/~1services~1{id}/put/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/400/content/application~1json/examples/required","paths/~1services~1{id}/put/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/put/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/put/responses/404/content/application~1json/examples/notFound"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1services~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/400/content/application~1json/examples/required","paths/~1services~1{id}/put/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/400/content/application~1json/examples/required","paths/~1services~1{id}/put/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/put/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/put/responses/404/content/application~1json/examples/notFound"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/put/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/updateservice"}],"panels":[]}]},"httpPath":"/services/{id}"},{"label":"Delete a service","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/deleteservice","routeSlug":"/services/deleteservice","metadata":{"seo":{"title":"Delete a service","description":"Delete a service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteService","name":"Delete a service","isWebhook":false,"pointer":"/paths/~1services~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","required":true}],"pointer":"/paths/~1services~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/services/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"svc_123456","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","404","500"],"pointer":"/services/{id}","href":"/services/deleteservice","openApiOperationId":"deleteService","summary":"Delete a service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Service deleted. No content returned."},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1services~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/deleteservice"}],"panels":[]}]},"httpPath":"/services/{id}"},{"label":"Assign or unassign providers for a service","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/patchserviceproviders","routeSlug":"/services/patchserviceproviders","metadata":{"seo":{"title":"Assign or unassign providers for a service","description":"Assign or unassign providers for a service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchServiceProviders","name":"Assign or unassign providers for a service","isWebhook":false,"pointer":"/paths/~1services~1provider~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign or unassign providers for a service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Service id.","required":true}],"pointer":"/paths/~1services~1provider~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceProviderRequest"}},"schemaId":"components/schemas/ServiceProviderRequest","pointer":"/paths/~1services~1provider~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/services/provider/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"svc_123456","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceProviderRequest"}},"responseCodes":["200","400","401","404","413","500"],"pointer":"/services/provider/{id}","href":"/services/patchserviceproviders","openApiOperationId":"patchServiceProviders","summary":"Assign or unassign providers for a service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/ServiceProviderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceProviderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Provider assignment updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceResponse"}},"schemaId":"components/schemas/ServiceResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Invalid payload, e.g. a provider id in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"assign"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"un_assign"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" does not exist for this account."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/400/content/application~1json/examples/providerNotFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/400/content/application~1json/examples/providerNotFound"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/notFound"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1services~1provider~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/400/content/application~1json/examples/providerNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/400/content/application~1json/examples/providerNotFound"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/notFound"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1services~1provider~1{id}/put/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/patchserviceproviders"}],"panels":[]}]},"httpPath":"/services/provider/{id}"}],"content":{"contentType":"group","meta":{"name":"Services"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Services","showPageActions":true},{"nodeType":"markdoc","content":"Create, fetch, update, and delete services, and manage provider assignments."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Service","link":"/services/service","deprecated":false},{"title":"ServiceLocation","link":"/services/servicelocation","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services","summary":"Fetch services by merchant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/getservicesbymerchant","deprecated":false},{"title":"/services","summary":"Create a service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/services/createservice","deprecated":false},{"title":"/services/{id}","summary":"Fetch a service by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/getservicebyid","deprecated":false},{"title":"/services/{id}","summary":"Update a service","prefix":{"name":"put","color":"put"},"badges":[],"link":"/services/updateservice","deprecated":false},{"title":"/services/{id}","summary":"Delete a service","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/services/deleteservice","deprecated":false},{"title":"/services/provider/{id}","summary":"Assign or unassign providers for a service","prefix":{"name":"put","color":"put"},"badges":[],"link":"/services/patchserviceproviders","deprecated":false}]}]}]}]}},{"type":"group","label":"Availability","link":"/availability","routeSlug":"/availability","items":[{"type":"link","label":"WorkingHours","link":"/availability/workinghours","routeSlug":"/availability/workinghours","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkingHours"},"seo":{"title":"WorkingHours"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkingHours","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkingHours"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/WorkingHours"}]}]}]}},{"type":"link","label":"WeekDayConfig","link":"/availability/weekdayconfig","routeSlug":"/availability/weekdayconfig","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WeekDayConfig"},"seo":{"title":"WeekDayConfig"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WeekDayConfig","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WeekDayConfig"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/WeekDayConfig"}]}]}]}},{"type":"link","label":"DayHours","link":"/availability/dayhours","routeSlug":"/availability/dayhours","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DayHours"},"seo":{"title":"DayHours"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DayHours","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DayHours"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/DayHours"}]}]}]}},{"type":"link","label":"HourRange","link":"/availability/hourrange","routeSlug":"/availability/hourrange","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"HourRange"},"seo":{"title":"HourRange"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"HourRange","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/HourRange"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/HourRange"}]}]}]}},{"label":"Fetch working hours for all staff","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/availability/getallstaffworkinghours","routeSlug":"/availability/getallstaffworkinghours","metadata":{"seo":{"title":"Fetch working hours for all staff","description":"Fetch working hours for all staff"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllStaffWorkingHours","name":"Fetch working hours for all staff","isWebhook":false,"pointer":"/paths/~1working-hours~1staffs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch working hours for all staff","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_id","in":"query","schemaId":"schema_8","required":true},{"name":"cursor","in":"query","schemaId":"schema_4","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page."},{"name":"limit","in":"query","schemaId":"schema_5"}],"pointer":"/paths/~1working-hours~1staffs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/working-hours/staffs","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"account_id","in":"query","required":true,"example":"acc_123456","schemaId":"schema_8"},{"name":"cursor","in":"query","required":false,"example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9","schemaId":"schema_4"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/working-hours/staffs","href":"/availability/getallstaffworkinghours","openApiOperationId":"getAllStaffWorkingHours","summary":"Fetch working hours for all staff"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Working hours fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkingHoursListResponse"}},"schemaId":"components/schemas/WorkingHoursListResponse"},{"code":"400","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bad Request: the request failed validation: a required field is missing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or a value is invalid ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/required","paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/required","paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1working-hours~1staffs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkingHoursListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkingHoursListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/required","paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/required","paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/availability/getallstaffworkinghours"}],"panels":[]}]},"httpPath":"/working-hours/staffs"},{"label":"Fetch working hours for a staff member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/availability/getstaffworkinghours","routeSlug":"/availability/getstaffworkinghours","metadata":{"seo":{"title":"Fetch working hours for a staff member","description":"Fetch working hours for a staff member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStaffWorkingHours","name":"Fetch working hours for a staff member","isWebhook":false,"pointer":"/paths/~1working-hours~1staffs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch working hours for a staff member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1","description":"Staff member id.","required":true}],"pointer":"/paths/~1working-hours~1staffs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/working-hours/staffs/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"staff_123456","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/working-hours/staffs/{id}","href":"/availability/getstaffworkinghours","openApiOperationId":"getStaffWorkingHours","summary":"Fetch working hours for a staff member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Working hours fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkingHoursResponse"}},"schemaId":"components/schemas/WorkingHoursResponse"},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1working-hours~1staffs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkingHoursResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkingHoursResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1working-hours~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/availability/getstaffworkinghours"}],"panels":[]}]},"httpPath":"/working-hours/staffs/{id}"}],"content":{"contentType":"group","meta":{"name":"Availability"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Availability","showPageActions":true},{"nodeType":"markdoc","content":"Fetch staff working hours."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"WorkingHours","link":"/availability/workinghours","deprecated":false},{"title":"WeekDayConfig","link":"/availability/weekdayconfig","deprecated":false},{"title":"DayHours","link":"/availability/dayhours","deprecated":false},{"title":"HourRange","link":"/availability/hourrange","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/working-hours/staffs","summary":"Fetch working hours for all staff","prefix":{"name":"get","color":"get"},"badges":[],"link":"/availability/getallstaffworkinghours","deprecated":false},{"title":"/working-hours/staffs/{id}","summary":"Fetch working hours for a staff member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/availability/getstaffworkinghours","deprecated":false}]}]}]}]}},{"type":"group","label":"Staffs","link":"/staffs","routeSlug":"/staffs","items":[{"type":"link","label":"Contact","link":"/staffs/contact","routeSlug":"/staffs/contact","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Contact"},"seo":{"title":"Contact"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Contact"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/Contact"}]}]}]}},{"type":"link","label":"ContactMethodEntry","link":"/staffs/contactmethodentry","routeSlug":"/staffs/contactmethodentry","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ContactMethodEntry"},"seo":{"title":"ContactMethodEntry"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ContactMethodEntry","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ContactMethodEntry"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/ContactMethodEntry"}]}]}]}},{"type":"link","label":"WebLinks","link":"/staffs/weblinks","routeSlug":"/staffs/weblinks","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WebLinks"},"seo":{"title":"WebLinks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebLinks","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WebLinks"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/WebLinks"}]}]}]}},{"type":"link","label":"SocialLinks","link":"/staffs/sociallinks","routeSlug":"/staffs/sociallinks","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SocialLinks"},"seo":{"title":"SocialLinks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SocialLinks","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SocialLinks"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/SocialLinks"}]}]}]}},{"type":"link","label":"ContactLocation","link":"/staffs/contactlocation","routeSlug":"/staffs/contactlocation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ContactLocation"},"seo":{"title":"ContactLocation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ContactLocation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ContactLocation"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/ContactLocation"}]}]}]}},{"type":"link","label":"CustomFields","link":"/staffs/customfields","routeSlug":"/staffs/customfields","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CustomFields"},"seo":{"title":"CustomFields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CustomFields","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CustomFields"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/CustomFields"}]}]}]}},{"label":"List staff contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/staffs/liststaffcontacts","routeSlug":"/staffs/liststaffcontacts","metadata":{"seo":{"title":"List staff contacts","description":"Retrieve a paginated list of all staff contacts within the account. Use cursor-based pagination for efficient retrieval of large result sets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStaffContacts","name":"List staff contacts","isWebhook":false,"pointer":"/paths/~1staff/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List staff contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a paginated list of all staff contacts within the account. Use cursor-based pagination for efficient retrieval of large result sets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_19","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page."},{"name":"limit","in":"query","schemaId":"schema_20"}],"pointer":"/paths/~1staff/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/staff","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"example":"ClASSmoVc35zdGFnaW5nLWNvbnRhY3RzYXBpcjELEgdDb250YWN0IiQyZmZhYWM0YS01MjgyLTQ2MWUtYWNlYS0yMDQ1MmQzYWFkNTkMGAAgAA==","schemaId":"schema_19"},{"name":"limit","in":"query","required":false,"example":25,"schemaId":"schema_20"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/staff","href":"/staffs/liststaffcontacts","openApiOperationId":"listStaffContacts","summary":"List staff contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of staff contacts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactListResponse","exampleIds":["paths/~1staff/get/responses/200/content/application~1json/examples/staffList"]}},"schemaId":"components/schemas/ContactListResponse","exampleIds":["paths/~1staff/get/responses/200/content/application~1json/examples/staffList"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1staff/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1staff/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1staff/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactListResponse","exampleIds":["paths/~1staff/get/responses/200/content/application~1json/examples/staffList"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactListResponse","exampleIds":["paths/~1staff/get/responses/200/content/application~1json/examples/staffList"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1staff/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1staff/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/staffs/liststaffcontacts"}],"panels":[]}]},"httpPath":"/staff"},{"label":"Get staff contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/staffs/getstaffcontact","routeSlug":"/staffs/getstaffcontact","metadata":{"seo":{"title":"Get staff contact","description":"Retrieve a staff contact including email_addresses, phone_numbers, scheduling information, and other profile data by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStaffContact","name":"Get staff contact","isWebhook":false,"pointer":"/paths/~1staff~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get staff contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve a staff contact including email_addresses, phone_numbers, scheduling information, and other profile data by id."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_21","required":true}],"pointer":"/paths/~1staff~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/staff/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"160018e3-57a6-480b-9811-9ac25b42501f","schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/staff/{id}","href":"/staffs/getstaffcontact","openApiOperationId":"getStaffContact","summary":"Get staff contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Staff contact details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1staff~1{id}/get/responses/200/content/application~1json/examples/staffContactDetails"]}},"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1staff~1{id}/get/responses/200/content/application~1json/examples/staffContactDetails"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: the contact does not belong to the caller's account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1staff~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1staff~1{id}/get/responses/200/content/application~1json/examples/staffContactDetails"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1staff~1{id}/get/responses/200/content/application~1json/examples/staffContactDetails"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1staff~1{id}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/staffs/getstaffcontact"}],"panels":[]}]},"httpPath":"/staff/{id}"}],"content":{"contentType":"group","meta":{"name":"Staffs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Staffs","showPageActions":true},{"nodeType":"markdoc","content":"Read staff contact details."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Contact","link":"/staffs/contact","deprecated":false},{"title":"ContactMethodEntry","link":"/staffs/contactmethodentry","deprecated":false},{"title":"WebLinks","link":"/staffs/weblinks","deprecated":false},{"title":"SocialLinks","link":"/staffs/sociallinks","deprecated":false},{"title":"ContactLocation","link":"/staffs/contactlocation","deprecated":false},{"title":"CustomFields","link":"/staffs/customfields","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/staff","summary":"List staff contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/staffs/liststaffcontacts","deprecated":false},{"title":"/staff/{id}","summary":"Get staff contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/staffs/getstaffcontact","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/customers","routeSlug":"/customers","items":[{"type":"link","label":"Contact","link":"/customers/contact","routeSlug":"/customers/contact","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Contact"},"seo":{"title":"Contact"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Contact"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/Contact"}]}]}]}},{"type":"link","label":"ContactMethodEntry","link":"/customers/contactmethodentry","routeSlug":"/customers/contactmethodentry","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ContactMethodEntry"},"seo":{"title":"ContactMethodEntry"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ContactMethodEntry","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ContactMethodEntry"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/ContactMethodEntry"}]}]}]}},{"type":"link","label":"WebLinks","link":"/customers/weblinks","routeSlug":"/customers/weblinks","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WebLinks"},"seo":{"title":"WebLinks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebLinks","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WebLinks"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/WebLinks"}]}]}]}},{"type":"link","label":"SocialLinks","link":"/customers/sociallinks","routeSlug":"/customers/sociallinks","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SocialLinks"},"seo":{"title":"SocialLinks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SocialLinks","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SocialLinks"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/SocialLinks"}]}]}]}},{"type":"link","label":"ContactLocation","link":"/customers/contactlocation","routeSlug":"/customers/contactlocation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ContactLocation"},"seo":{"title":"ContactLocation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ContactLocation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ContactLocation"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/ContactLocation"}]}]}]}},{"type":"link","label":"CustomFields","link":"/customers/customfields","routeSlug":"/customers/customfields","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CustomFields"},"seo":{"title":"CustomFields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CustomFields","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CustomFields"},"children":[],"type":"tag","tag":"schemaDefinition","annotations":[{"type":"attribute","name":"showWriteOnly","value":true},{"type":"attribute","name":"schemaRef","value":"#/components/schemas/CustomFields"}]}]}]}},{"label":"List customer contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/listcustomercontacts","routeSlug":"/customers/listcustomercontacts","metadata":{"seo":{"title":"List customer contacts","description":"Retrieve a paginated list of all customer contacts within the account. Use cursor-based pagination for efficient retrieval of large result sets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomerContacts","name":"List customer contacts","isWebhook":false,"pointer":"/paths/~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customer contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a paginated list of all customer contacts within the account. Use cursor-based pagination for efficient retrieval of large result sets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_22","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page."},{"name":"limit","in":"query","schemaId":"schema_20"}],"pointer":"/paths/~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"example":"Cm4KHAoPbGFzdFVwZGF0ZWREYXRlEgkIuPWz3P-HkwMSSmoVc35zdGFnaW5nLWNvbnRhY3RzYXBpcjELEgdDb250YWN0IiQ0M2Y3MjliOS04MDMxLTRjNWYtODMzYS04Yjg5OWRhMzYxNzAMGAAgAQ==","schemaId":"schema_22"},{"name":"limit","in":"query","required":false,"example":25,"schemaId":"schema_20"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/customers","href":"/customers/listcustomercontacts","openApiOperationId":"listCustomerContacts","summary":"List customer contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of customer contacts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactListResponse","exampleIds":["paths/~1customers/get/responses/200/content/application~1json/examples/customerList"]}},"schemaId":"components/schemas/ContactListResponse","exampleIds":["paths/~1customers/get/responses/200/content/application~1json/examples/customerList"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactListResponse","exampleIds":["paths/~1customers/get/responses/200/content/application~1json/examples/customerList"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactListResponse","exampleIds":["paths/~1customers/get/responses/200/content/application~1json/examples/customerList"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/listcustomercontacts"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Create a customer contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/createcustomercontact","routeSlug":"/customers/createcustomercontact","metadata":{"seo":{"title":"Create a customer contact","description":"Create a customer contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomerContact","name":"Create a customer contact","isWebhook":false,"pointer":"/paths/~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a customer contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers/post/requestBody/content/application~1json/examples/createWithMultipleEmailsAndPhones"]}},"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers/post/requestBody/content/application~1json/examples/createWithMultipleEmailsAndPhones"],"pointer":"/paths/~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers/post/requestBody/content/application~1json/examples/createWithMultipleEmailsAndPhones"]}},"responseCodes":["201","400","401","403","413","500"],"pointer":"/customers","href":"/customers/createcustomercontact","openApiOperationId":"createCustomerContact","summary":"Create a customer contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers/post/requestBody/content/application~1json/examples/createWithMultipleEmailsAndPhones"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers/post/requestBody/content/application~1json/examples/createWithMultipleEmailsAndPhones"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Customer contact created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"Bad request: invalid input.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/400/content/application~1json/examples/validationFailed"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/400/content/application~1json/examples/validationFailed"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers/post/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers/post/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: cannot create a contact under an internal account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/403/content/application~1json/examples/forbidden"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/400/content/application~1json/examples/validationFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/400/content/application~1json/examples/validationFailed"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers/post/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers/post/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers/post/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomercontact"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Get customer contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/getcustomercontact","routeSlug":"/customers/getcustomercontact","metadata":{"seo":{"title":"Get customer contact","description":"Retrieve complete details for a specific customer contact including all contact methods, location, social profiles, and custom fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomerContact","name":"Get customer contact","isWebhook":false,"pointer":"/paths/~1customers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get customer contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve complete details for a specific customer contact including all contact methods, location, social profiles, and custom fields."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_23","required":true}],"pointer":"/paths/~1customers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"eaafecfe-8c33-428a-88bd-ba4d012793aa","schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/customers/{id}","href":"/customers/getcustomercontact","openApiOperationId":"getCustomerContact","summary":"Get customer contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer contact details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers~1{id}/get/responses/200/content/application~1json/examples/contactDetails"]}},"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers~1{id}/get/responses/200/content/application~1json/examples/contactDetails"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: the contact does not belong to the caller's account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1customers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers~1{id}/get/responses/200/content/application~1json/examples/contactDetails"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers~1{id}/get/responses/200/content/application~1json/examples/contactDetails"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomercontact"}],"panels":[]}]},"httpPath":"/customers/{id}"},{"label":"Update a customer contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/updatecustomercontact","routeSlug":"/customers/updatecustomercontact","metadata":{"seo":{"title":"Update a customer contact","description":"Update an existing customer contact with full or partial modifications. Supports add/update/delete semantics for contact methods (emails, phones) and overwriting of web/social links and location data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomerContact","name":"Update a customer contact","isWebhook":false,"pointer":"/paths/~1customers~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a customer contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing customer contact with full or partial modifications. Supports add/update/delete semantics for contact methods (emails, phones) and overwriting of web/social links and location data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_23","required":true}],"pointer":"/paths/~1customers~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers~1{id}/put/requestBody/content/application~1json/examples/updateWithDeleteAndAdd"]}},"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers~1{id}/put/requestBody/content/application~1json/examples/updateWithDeleteAndAdd"],"pointer":"/paths/~1customers~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/customers/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"eaafecfe-8c33-428a-88bd-ba4d012793aa","schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers~1{id}/put/requestBody/content/application~1json/examples/updateWithDeleteAndAdd"]}},"responseCodes":["200","400","401","403","404","413","500"],"pointer":"/customers/{id}","href":"/customers/updatecustomercontact","openApiOperationId":"updateCustomerContact","summary":"Update a customer contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers~1{id}/put/requestBody/content/application~1json/examples/updateWithDeleteAndAdd"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRequest","exampleIds":["paths/~1customers~1{id}/put/requestBody/content/application~1json/examples/updateWithDeleteAndAdd"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer contact updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers~1{id}/put/responses/200/content/application~1json/examples/updated"]}},"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers~1{id}/put/responses/200/content/application~1json/examples/updated"]},{"code":"400","description":"Bad request: invalid input, or the contact has already been deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/validationFailed","paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/alreadyDeleted"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/validationFailed","paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/alreadyDeleted"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: the contact does not belong to the caller's account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/notFound"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1customers~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers~1{id}/put/responses/200/content/application~1json/examples/updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactResponse","exampleIds":["paths/~1customers~1{id}/put/responses/200/content/application~1json/examples/updated"]}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/validationFailed","paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/alreadyDeleted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/validationFailed","paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/alreadyDeleted"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/notFound"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/put/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/updatecustomercontact"}],"panels":[]}]},"httpPath":"/customers/{id}"},{"label":"Delete a customer contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/deletecustomercontact","routeSlug":"/customers/deletecustomercontact","metadata":{"seo":{"title":"Delete a customer contact","description":"Delete a specific customer contact. The contact and all associated data are removed from the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomerContact","name":"Delete a customer contact","isWebhook":false,"pointer":"/paths/~1customers~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a customer contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a specific customer contact. The contact and all associated data are removed from the system."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_23","required":true}],"pointer":"/paths/~1customers~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{id}","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"eaafecfe-8c33-428a-88bd-ba4d012793aa","schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/customers/{id}","href":"/customers/deletecustomercontact","openApiOperationId":"deleteCustomerContact","summary":"Delete a customer contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Customer contact deleted successfully. No content returned."},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: cannot delete an internal contact, or the contact does not belong to the caller's account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":"Not Found: no resource exists for the given id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1customers~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/unknownId","paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1{id}/delete/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/deletecustomercontact"}],"panels":[]}]},"httpPath":"/customers/{id}"},{"label":"Create customer contacts in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/createcustomercontactsbulk","routeSlug":"/customers/createcustomercontactsbulk","metadata":{"seo":{"title":"Create customer contacts in bulk","description":"Creates multiple customer contacts in a single request. Uses partial-success semantics: each contact is processed independently. Always returns 200 with per-item status codes in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomerContactsBulk","name":"Create customer contacts in bulk","isWebhook":false,"pointer":"/paths/~1customers~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create customer contacts in bulk","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates multiple customer contacts in a single request. Uses partial-success semantics: each contact is processed independently. Always returns 200 with per-item status codes in the response.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24","pointer":"/paths/~1customers~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/bulk","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24"}},"responseCodes":["200","400","401","403","413","500"],"pointer":"/customers/bulk","href":"/customers/createcustomercontactsbulk","openApiOperationId":"createCustomerContactsBulk","summary":"Create customer contacts in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bulk operation completed, check individual item statuses.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreateContactResponse","exampleIds":["paths/~1customers~1bulk/post/responses/200/content/application~1json/examples/mixedResults"]}},"schemaId":"components/schemas/BulkCreateContactResponse","exampleIds":["paths/~1customers~1bulk/post/responses/200/content/application~1json/examples/mixedResults"]},{"code":"400","description":"Bad request: invalid input or empty body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/400/content/application~1json/examples/emptyRequest"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/400/content/application~1json/examples/emptyRequest"]},{"code":"401","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unauthorized: the request has no usable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") or the bearer token has expired ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/tokenExpired"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/tokenExpired"]},{"code":"403","description":"Forbidden: cannot create a contact under an internal account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/403/content/application~1json/examples/forbidden"]},{"code":"413","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payload Too Large: a value exceeds its documented size limit (string length,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"array size, or number of object entries), e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" over 255 characters."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/413/content/application~1json/examples/payloadTooLarge"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/413/content/application~1json/examples/payloadTooLarge"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1customers~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkCreateContactResponse","exampleIds":["paths/~1customers~1bulk/post/responses/200/content/application~1json/examples/mixedResults"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreateContactResponse","exampleIds":["paths/~1customers~1bulk/post/responses/200/content/application~1json/examples/mixedResults"]}}},{"code":"400","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/400/content/application~1json/examples/emptyRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/400/content/application~1json/examples/emptyRequest"]}}},{"code":"401","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/tokenExpired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/missingAuthorization","paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/tokenExpired"]}}},{"code":"403","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"413","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/413/content/application~1json/examples/payloadTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/413/content/application~1json/examples/payloadTooLarge"]}}},{"code":"500","schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorsEnvelope","exampleIds":["paths/~1customers~1bulk/post/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomercontactsbulk"}],"panels":[]}]},"httpPath":"/customers/bulk"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":"Create, fetch, update, delete, and bulk-create customer contacts."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Contact","link":"/customers/contact","deprecated":false},{"title":"ContactMethodEntry","link":"/customers/contactmethodentry","deprecated":false},{"title":"WebLinks","link":"/customers/weblinks","deprecated":false},{"title":"SocialLinks","link":"/customers/sociallinks","deprecated":false},{"title":"ContactLocation","link":"/customers/contactlocation","deprecated":false},{"title":"CustomFields","link":"/customers/customfields","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers","summary":"List customer contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/listcustomercontacts","deprecated":false},{"title":"/customers","summary":"Create a customer contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/createcustomercontact","deprecated":false},{"title":"/customers/{id}","summary":"Get customer contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomercontact","deprecated":false},{"title":"/customers/{id}","summary":"Update a customer contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/customers/updatecustomercontact","deprecated":false},{"title":"/customers/{id}","summary":"Delete a customer contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers/deletecustomercontact","deprecated":false},{"title":"/customers/bulk","summary":"Create customer contacts in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/createcustomercontactsbulk","deprecated":false}]}]}]}]}},{"type":"group","label":"Changelog","link":"/changelog","routeSlug":"/changelog","items":[{"type":"link","label":"v2","link":"/changelog/v2","routeSlug":"/changelog/v2","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"v2"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"/changelog/v2"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2 is a redesign of the Setmore API, not a drop-in update of v1. It covers more of the platform (bookings, class sessions, events, services, categories, working hours, staff and customer contacts), and it uses one consistent request and response style across every endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2 is not backwards compatible with v1."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" The base URL, endpoint paths, field names, response format, and error format have all changed. Plan to update your integration before you switch over."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[]}]}},{"type":"link","label":"At a glance","link":"/changelog/at-a-glance","routeSlug":"/changelog/at-a-glance","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"At a glance"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"/changelog/at-a-glance"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"At a glance"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v1"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Base URL"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"https://developer.setmore.com/api/v1/bookingapi"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"https://developer.setmore.com/api/v2"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Success response"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ \"response\": true, \"msg\": \"...\", \"data\": { ... } }"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ \"data\": { ... } }"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List response"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Varies by endpoint"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ \"data\": [ ... ], \"cursor\": \"...\" }"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Error response"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ \"response\": false, \"error\": \"...\", \"msg\": \"...\" }"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"{ \"errors\": [ { \"code\": \"...\", \"message\": \"...\" } ] }"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Failures"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Some validation failures were returned with HTTP "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"200"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Failures always use a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"4xx"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"5xx"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" HTTP status"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Identifiers"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"staff_key"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_key"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"customer_key"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"key"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"consumer_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Dates and times"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2025-01-20T09:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DD/MM/YYYY"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for slots"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), for example "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-01-20T09:00:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-01-20T17:00:00+08:00"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Paging"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"cursor"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" on appointments only"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"cursor"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"limit"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" on every list endpoint"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authentication"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bearer access token"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bearer access token (see Authentication in the Getting Started section above)"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"panels":[]}]}},{"type":"link","label":"Migrating from v1","link":"/changelog/migrating-from-v1","routeSlug":"/changelog/migrating-from-v1","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Migrating from v1"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"/changelog/migrating-from-v1"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Migrating from v1"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Change your base URL to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"https://developer.setmore.com/api/v2"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Find each v1 call you use in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/changelog/endpoint-map"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"endpoint map"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" below and switch to its v2 equivalent."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Rename request fields using the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/changelog/field-map"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"field map"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". IDs, dates, and several field names changed."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update your response parsing. Read the result from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and read failures from the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"errors"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" array (check the HTTP status first)."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Handle paging. Pass the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cursor"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a response to fetch the next page, and stop when no "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cursor"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is returned."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Test your updated integration end to end before you go live."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"panels":[]}]}},{"type":"link","label":"Endpoint map","link":"/changelog/endpoint-map","routeSlug":"/changelog/endpoint-map","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Endpoint map"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"/changelog/endpoint-map"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint map"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Every v1 endpoint has a v2 equivalent, except where noted."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"What you do"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v1"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List staff"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /staffs"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /staff"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /staff/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for one staff member"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List services"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /services"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /services"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /services/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for one service"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List categories"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /services/categories"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /categories"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /categories/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for one category"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Services in a category"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /services/categories/{category-key}"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /categories/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" returns the category with its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Then fetch each service with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /services/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Get available slots"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /slots"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /slots"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (parameters are now query parameters)"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a customer"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /customer/create"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /customers"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Find customers"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /customer"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /customers"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (list), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /customers/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"firstname"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"phone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"email"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" filters are not available in v2."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create an appointment"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /appointment/create"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /bookings"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"APPOINTMENT"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fetch appointments"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /appointments"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /bookings/staffs/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (by staff member) or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /bookings/customers/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (by customer)"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update an appointment label"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /appointments/{appointment-id}/label"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /bookings/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Send the booking with the new "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"panels":[]}]}},{"type":"link","label":"Field map","link":"/changelog/field-map","routeSlug":"/changelog/field-map","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Field map"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"/changelog/field-map"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Field map"},"children":[],"type":"text"}],"type":"heading"}]}],"panels":[]}]}},{"type":"link","label":"Create an appointment is now create a booking","link":"/changelog/create-an-appointment-is-now-create-a-booking","routeSlug":"/changelog/create-an-appointment-is-now-create-a-booking","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Create an appointment is now create a booking"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":4,"id":"/changelog/create-an-appointment-is-now-create-a-booking"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create an appointment is now create a booking"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v1 field"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2 field"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Notes"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"staff_key"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_id"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_key"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"customer_key"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"consumer_ids"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A list. Send exactly one customer for an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"APPOINTMENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_time"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339 with an offset, for example "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-01-20T09:00:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-01-20T17:00:00+08:00"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_time"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_at"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339 with an offset"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"comment"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"notes"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unchanged"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not available"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"New and required: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"APPOINTMENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SESSION"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not available"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"account_id"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"New and required: the Setmore account that owns the booking"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not available"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"cost"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"source"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"meta_data"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"New and optional"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"panels":[]}]}},{"type":"link","label":"Get available slots","link":"/changelog/get-available-slots","routeSlug":"/changelog/get-available-slots","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Get available slots"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":4,"id":"/changelog/get-available-slots"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Get available slots"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v1 field"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2 field"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Notes"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"staff_key"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_id"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_key"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"duration"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Send the length of the meeting in minutes instead of a service."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"selected_date"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DD/MM/YYYY"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_at"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A date range of up to 7 days"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Now required. Use an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iana.org/time-zones"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IANA time zone"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" name."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"slot_limit"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"slot_limit"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Maximum raised from 30 to 100. The default is 15."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"double_booking"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"double_booking"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional, defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"false"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"off_hours"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"working_hours"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional, defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"false"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not available"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"account_id"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"New and required"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Each slot in the response now includes both "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", grouped by day under "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data.days"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[]}]}},{"type":"link","label":"Customers are now customer contacts","link":"/changelog/customers-are-now-customer-contacts","routeSlug":"/changelog/customers-are-now-customer-contacts","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Customers are now customer contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":4,"id":"/changelog/customers-are-now-customer-contacts"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customers are now customer contacts"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v1 field"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2 field"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"first_name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"last_name"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"first_name"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"last_name"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"email_id"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"email_addresses"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (a list, up to 10)"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"cell_phone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"work_phone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"home_phone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"country_code"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"phone_numbers"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (a list, up to 10)"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"address"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"city"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"state"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"postal_code"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"address"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"city"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"state"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"country"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"zip"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"image_url"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"avatar_url"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"additional_fields"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"custom_fields"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"comment"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"company_key"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"contact_type"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Not available in v2"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"panels":[]}]}},{"type":"link","label":"Services","link":"/changelog/services","routeSlug":"/changelog/services","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Services"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":4,"id":"/changelog/services"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Services"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v1 field"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2 field"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"key"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_name"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"staff_keys"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_ids"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"buffer_duration"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"buffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"before"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"after"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in minutes"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"duration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cost"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Carried over, with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"duration"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in minutes"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"currency"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Not sent in v2. A service uses your Setmore account's currency, which is returned on the service"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"description"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"image_url"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Not available in v2"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not available"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"max_seats"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"visibility"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"color_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"category_ids"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"panels":[]}]}},{"type":"link","label":"Staff and categories","link":"/changelog/staff-and-categories","routeSlug":"/changelog/staff-and-categories","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Staff and categories"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":4,"id":"/changelog/staff-and-categories"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Staff and categories"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v1"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Staff "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"key"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and contact fields"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", with the same contact fields as customers above"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"key"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"categoryName"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"title"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"companyId"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"account_id"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"serviceIdList"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_ids"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"categoryOrder"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"createdDate"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Not available in v2"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not available"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"description"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"color_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"image_url"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"visibility"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"panels":[]}]}},{"type":"link","label":"Errors","link":"/changelog/errors","routeSlug":"/changelog/errors","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Errors"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"/changelog/errors"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Errors"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"v2 returns every error in one format, with a stable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" you can handle in code and a readable "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"message"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":":"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"{\n  \"errors\": [\n    { \"code\": \"resource_not_found\", \"message\": \"The requested resource does not exist.\" }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"{\n  \"errors\": [\n    { \"code\": \"resource_not_found\", \"message\": \"The requested resource does not exist.\" }\n  ]\n}\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use the HTTP status first, then the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The most common ones:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HTTP status"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Code"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When you see it"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required field is missing or blank"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A value is not valid, for example an unknown "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when fetching slots"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"out_of_range"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A range or count is outside what is allowed, for example a slots range over 7 days"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"401"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"No bearer token was sent, or it has expired"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"403"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"action_forbidden"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The action isn't allowed for this account"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"404"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"resource_not_found"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The id does not exist, for example when deleting an unknown service"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"409"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"resource_conflict"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The request conflicts with the current state, for example a duplicate category title"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"413"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"payload_too_large"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A value is larger than allowed"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"429"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"You are sending requests too quickly. Slow down and retry."},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"500"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"server_error"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Something went wrong on our side"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The full list of error codes is in the Getting Started section at the top of this page."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[]}]}},{"type":"link","label":"What's new in v2","link":"/changelog/what's-new-in-v2","routeSlug":"/changelog/what's-new-in-v2","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"What's new in v2"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"/changelog/what's-new-in-v2"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"What's new in v2"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bookings"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create, fetch, update, and delete any booking by id ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/bookings/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Book group classes: use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type: SESSION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" service. A session holds up to 50 customers, and never more than the class's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"max_seats"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add or remove a customer on a class session ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELETE /bookings/class/{session-id}/attendees/{customer-id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create and update events, which are calendar entries that aren't tied to a service ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/bookings/events"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Attach a video meeting to a booking with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"List bookings by staff member or by customer, with date filters ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") and paging."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Slots"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fetch upcoming class sessions and their seat availability ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /slots/class/{class-key}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). A class with no upcoming sessions returns an empty "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"days"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" map."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Slots now return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"end_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as well as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Services and categories"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create, update, and delete services and categories (v1 was read-only)."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Assign or unassign staff members for a service ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /services/provider/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Filter services by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and include deleted services with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"is_deleted"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Categories reference their services ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), and services reference their categories ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"category_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Every service is also in the default category for its type: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"All Services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"All Class Bookings"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". It is added when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"category_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is empty or leaves it out. Each id in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"category_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must be an existing category of your account, and an id must not be repeated."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" needs at least one id in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; ids that are empty or the text "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are rejected."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of a service cannot be changed after it is created."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"currency"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" cannot be sent when you create or update a service; the service uses your account's currency."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Working hours"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fetch the working hours of every staff member, or of one staff member ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/working-hours/staffs"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Contacts"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update and delete customer contacts, and create many at once with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /customers/bulk"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Read staff contacts ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/staff"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"panels":[]}]}},{"type":"link","label":"Good to know","link":"/changelog/good-to-know","routeSlug":"/changelog/good-to-know","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Good to know"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"/changelog/good-to-know"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Good to know"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Dates and times."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset for every date and time you send: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC, or a numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Responses are not always in UTC: bookings are returned in UTC, and available slots in the offset of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" you request. Read the offset in each value instead of assuming UTC; see Time standards in the Getting Started section above."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updating by id."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" When you update a booking, an event, or a service, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the request body must match the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the URL, otherwise you receive "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". You can also leave the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" out of the body."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Rate limits."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" The v2 API is rate limited. If you exceed the limit you receive "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Full details."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Every endpoint, field, limit, and example is in the endpoint sections of this page."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Changelog"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Changelog","showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/changelog"}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/Booking":{"id":"components/schemas/Booking","kind":"json-schema","title":"Booking","data":{"type":"object","description":"A booking, as returned in API responses.","x-tags":["Bookings"],"properties":{"id":{"type":"string","example":"bk_123456"},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"What kind of booking this is:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"APPOINTMENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": a one-to-one booking for a single customer."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SESSION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": one scheduled run of a group class, which several customers can"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"attend. Who is attending a session is changed with the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/addclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add a customer to a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/removeclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove a customer from a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"EVENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": a calendar entry that is not tied to a service, created with"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/createevent"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create an event"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". It has no "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cost"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"enum":["SESSION","APPOINTMENT","EVENT"],"example":"APPOINTMENT"},"calendar_id":{"type":"string","example":"cal_123456"},"account_id":{"type":"string","example":"acc_123456"},"provider_id":{"type":"string","description":"Id of the staff member assigned to this booking.","example":"provider_123456"},"consumer_ids":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ids of the customers attending this booking."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Appointment:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" always exactly 1 customer."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Session (group class):"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" anywhere from 0 customers up to the number of seats the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"class offers (the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"max_seats"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of its service). To change who is attending, use"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/addclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add a customer to a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/removeclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove a customer from a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":";"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"updating the booking does not change it."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"maxItems":50,"items":{"type":"string"},"example":["cust_123456"]},"service_id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Id of the service booked. Empty for an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"EVENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"svc_123456"},"start_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Start of the booking, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in UTC ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). A time sent with"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"an offset is returned as the same moment in UTC: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T08:30:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is returned as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T00:30:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-01-20T09:00:00Z"},"end_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"End of the booking, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in UTC ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), as the same"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"moment as it was sent."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-01-20T10:00:00Z"},"booking_id":{"type":"string","description":"External booking reference id.","example":"ext_bk_654321"},"cost":{"type":"number","format":"double","minimum":0,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Empty for an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"EVENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":50},"title":{"type":"string","maxLength":255,"example":"Consultation"},"notes":{"type":"string","maxLength":1500,"example":"Customer requested a reminder call the day before."},"status":{"type":"string","enum":["CANCELLED","CONFIRMED"],"example":"CONFIRMED"},"label":{"type":"string","maxLength":100,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Free-text label for the booking, e.g. a status or reminder tag such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RUNNING_LATE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"NO_SHOW"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Empty for an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"EVENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"RUNNING_LATE"},"location":{"$ref":"#/components/schemas/BookingLocation"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When the booking was created, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in UTC ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-01-15T12:00:00Z"},"source":{"type":"string","maxLength":100,"example":"booking_page"},"meta_data":{"type":"object","description":"Unstructured key/value passthrough data, with up to 5 entries and each value up to 1500 characters.","maxProperties":5,"additionalProperties":{"type":"string","maxLength":1500},"example":{"referred_by":"google_ads"}}}}},"components/schemas/BookingLocation":{"id":"components/schemas/BookingLocation","kind":"json-schema","title":"BookingLocation","data":{"type":"object","description":"Meeting location of a booking.","x-tags":["Bookings"],"properties":{"type":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Empty (or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") when there is no video meeting, otherwise "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","enum":["videoType"]},"example":["videoType"]},"video_type":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The video meeting, present when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the video meeting.","example":"vid_123456"},"link":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video conferencing URL ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI syntax)."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://meet.google.com/abc-defg-hij"},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video conferencing provider: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"google-meet"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"zoom"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"google-meet"}}}}}}},"components/schemas/Slots":{"id":"components/schemas/Slots","kind":"json-schema","title":"Slots","data":{"type":"object","description":"Bookable time slots grouped by day.","x-tags":["Slots"],"properties":{"days":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Map keyed by the local date ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in the requested "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") to the list of bookable slots on that day."},"children":[],"type":"text"}],"type":"paragraph"}],"additionalProperties":{"type":"array","items":{"type":"object","properties":{"start_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Slot start, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"in the offset of the requested"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", not necessarily UTC: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Asia/Singapore"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for a zone at UTC. The offset"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"follows daylight saving time, so read it rather than assuming UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T08:30:00+08:00"},"end_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Slot end, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with the same offset as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T09:00:00+08:00"}}}},"example":{"2026-11-19":[{"start_at":"2026-11-19T08:30:00+08:00","end_at":"2026-11-19T09:00:00+08:00"},{"start_at":"2026-11-19T09:00:00+08:00","end_at":"2026-11-19T09:30:00+08:00"}]}}}}},"components/schemas/ClassSlots":{"id":"components/schemas/ClassSlots","kind":"json-schema","title":"ClassSlots","data":{"type":"object","description":"Upcoming sessions of a class, grouped by day.","x-tags":["Slots"],"properties":{"days":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Map keyed by date ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in the requested "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") to the list of"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"class sessions starting on that day, ordered by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Empty when the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"class has no upcoming sessions, or no sessions yet."},"children":[],"type":"text"}],"type":"paragraph"}],"additionalProperties":{"type":"array","items":{"type":"object","properties":{"session_id":{"type":"string","description":"Id of the class session (the underlying event).","example":"evt_123456"},"start_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Session start, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in UTC ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). The requested"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timezone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" only decides which day the session is listed under."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-01-20T09:00:00Z"},"end_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Session end, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in UTC ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-01-20T09:30:00Z"},"provider_id":{"type":"string","description":"Staff member running the session.","example":"provider_123456"},"remaining_seats":{"type":"integer","description":"Seats still available for booking (never negative).","example":7}}}},"example":{"2026-01-20":[{"session_id":"evt_123456","start_at":"2026-01-20T09:00:00Z","end_at":"2026-01-20T09:30:00Z","provider_id":"provider_123456","remaining_seats":7}]}}}}},"components/schemas/Category":{"id":"components/schemas/Category","kind":"json-schema","title":"Category","data":{"type":"object","description":"A category, as returned in API responses.","x-tags":["Categories"],"properties":{"id":{"type":"string","example":"cat_123456"},"account_id":{"type":"string","example":"acc_123456"},"description":{"type":"string","maxLength":1500,"example":"Standard haircut services"},"title":{"type":"string","maxLength":255,"example":"Haircuts"},"service_ids":{"type":"array","items":{"type":"string"},"example":["svc_123456"]},"color_code":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Hex color code, e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"#FF5733"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"pattern":"^#[0-9A-Fa-f]{6}$","maxLength":7,"example":"#FF5733"},"image_url":{"type":"string","format":"uri","example":"https://cdn.example.com/categories/haircuts.png"},"visibility":{"type":"string","enum":["PUBLIC","PRIVATE","UNAVAILABLE"],"example":"PUBLIC"}}}},"components/schemas/Service":{"id":"components/schemas/Service","kind":"json-schema","title":"Service","data":{"type":"object","description":"A service, as returned in API responses.","x-tags":["Services"],"properties":{"id":{"type":"string","example":"svc_123456"},"account_id":{"type":"string","example":"acc_123456"},"title":{"type":"string","maxLength":255,"example":"30 min consultation"},"provider_ids":{"type":"array","items":{"type":"string"},"example":["provider_123456"]},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Whether this is a one-to-one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or a group "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["SERVICE","CLASS"],"example":"SERVICE"},"max_seats":{"type":"integer","minimum":1,"maximum":50,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Seat capacity of the class. Present only when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":10},"cost":{"type":"number","format":"float","minimum":0,"example":50},"duration":{"type":"integer","minimum":1,"maximum":1439,"example":30},"color_code":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","maxLength":7,"example":"#4287f5"},"buffer":{"type":"object","properties":{"before":{"type":"integer","minimum":0,"maximum":1439,"example":5},"after":{"type":"integer","minimum":0,"maximum":1439,"example":5}}},"visibility":{"type":"string","enum":["PUBLIC","PRIVATE","UNAVAILABLE"],"example":"PUBLIC"},"location":{"$ref":"#/components/schemas/ServiceLocation"},"category_ids":{"type":"array","items":{"type":"string"},"example":["cat_123456"]},"currency":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 4217"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" currency code of the Setmore account. A service is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"priced in the account's currency, so this is set by Setmore and cannot be sent when you create or update a service."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"USD"}}}},"components/schemas/ServiceLocation":{"id":"components/schemas/ServiceLocation","kind":"json-schema","title":"ServiceLocation","data":{"type":"object","description":"Where the service is delivered.","x-tags":["Services"],"properties":{"type":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Empty (or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") when there is no video meeting, otherwise "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","enum":["videoType"]},"example":["videoType"]},"video_type":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The video meeting, present when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video conferencing provider: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"google-meet"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"zoom"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"google-meet"},"is_default":{"type":"boolean","description":"Whether this is the default video meeting for the service.","example":true}}}}}}},"components/schemas/WorkingHours":{"id":"components/schemas/WorkingHours","kind":"json-schema","title":"WorkingHours","data":{"type":"object","description":"A staff member's weekly working hours.","x-tags":["Availability"],"required":["account_id","provider_id","timezone","week_day_config"],"properties":{"account_id":{"type":"string","description":"Setmore account id.","example":"acc_123456"},"provider_id":{"type":"string","description":"Staff member id.","example":"provider_123456"},"timezone":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iana.org/time-zones"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IANA Time Zone Database"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" identifier."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"America/New_York"},"week_day_config":{"$ref":"#/components/schemas/WeekDayConfig"}}}},"components/schemas/WeekDayConfig":{"id":"components/schemas/WeekDayConfig","kind":"json-schema","title":"WeekDayConfig","data":{"type":"object","description":"Weekly configuration of working hours, keyed by two-letter day abbreviation.","x-tags":["Availability"],"properties":{"MO":{"$ref":"#/components/schemas/DayHours"},"TU":{"$ref":"#/components/schemas/DayHours"},"WE":{"$ref":"#/components/schemas/DayHours"},"TH":{"$ref":"#/components/schemas/DayHours"},"FR":{"$ref":"#/components/schemas/DayHours"},"SA":{"$ref":"#/components/schemas/DayHours"},"SU":{"$ref":"#/components/schemas/DayHours"}}}},"components/schemas/DayHours":{"id":"components/schemas/DayHours","kind":"json-schema","title":"DayHours","data":{"type":"object","description":"Hours configuration for a single day.","x-tags":["Availability"],"properties":{"hours":{"type":"array","description":"Working hour ranges for the day.","items":{"$ref":"#/components/schemas/HourRange"}},"breaks":{"type":"array","description":"Break hour ranges for the day.","items":{"$ref":"#/components/schemas/HourRange"}},"crossDay":{"type":"boolean","description":"Indicates if the hours cross into the next day.","example":false}},"example":{"hours":[{"start":540,"end":1020}],"breaks":[],"crossDay":false}}},"components/schemas/HourRange":{"id":"components/schemas/HourRange","kind":"json-schema","title":"HourRange","data":{"type":"object","description":"A range of hours within a day, in minutes since midnight.","x-tags":["Availability"],"properties":{"start":{"type":"integer","minimum":0,"maximum":1439,"description":"Start time, minutes of day.","example":540},"end":{"type":"integer","minimum":0,"maximum":1439,"description":"End time, minutes of day.","example":1020}}}},"components/schemas/Contact":{"id":"components/schemas/Contact","kind":"json-schema","title":"Contact","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Contact object returned in API responses. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"urls"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"social"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"custom_fields"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are always present, as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when the contact has none set. They are never omitted."},"children":[],"type":"text"}],"type":"paragraph"}],"x-tags":["Staffs","Customers"],"properties":{"id":{"type":"string","example":"160018e3-57a6-480b-9811-9ac25b42501f"},"first_name":{"type":"string","maxLength":1500,"example":"Eren"},"last_name":{"type":"string","maxLength":1500,"example":"Yeager"},"avatar_url":{"type":"string","format":"uri","maxLength":1500,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for URI syntax."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://avatar.example.com/eren"},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/ContactMethodEntry"},"description":"List of email entries with id, value, and primary flag."},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/ContactMethodEntry"},"description":"List of phone entries with id, value, and primary flag."},"urls":{"$ref":"#/components/schemas/WebLinks"},"social":{"$ref":"#/components/schemas/SocialLinks"},"location":{"$ref":"#/components/schemas/ContactLocation"},"custom_fields":{"$ref":"#/components/schemas/CustomFields"}}}},"components/schemas/ContactMethodEntry":{"id":"components/schemas/ContactMethodEntry","kind":"json-schema","title":"ContactMethodEntry","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Represents an email or phone entry. To add: provide "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"value"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (and optionally "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"primary: true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). To update: provide "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"value"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". To delete: provide "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"deleted: true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". When multiple entries set "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"primary: true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the last one wins."},"children":[],"type":"text"}],"type":"paragraph"}],"x-tags":["Staffs","Customers"],"properties":{"id":{"type":"string","description":"System-generated identifier. Returned in responses; pass it when updating or deleting an existing entry.","example":"20cb5d9a-54cf-445e-8748-fd47aa765b58"},"value":{"type":"string","maxLength":1500,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The email address or phone number. Emails informally follow "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc5322"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 5322"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":";"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"phone numbers are recommended in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.itu.int/rec/T-REC-E.164"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"E.164"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" format (e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+14155552671"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"No strict pattern is enforced at the schema level."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"eren.yeager221@gmail.com"},"primary":{"type":"boolean","description":"Whether this is the primary entry for its type.","example":true},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" together with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete the entry."},"children":[],"type":"text"}],"type":"paragraph"}],"example":false}}}},"components/schemas/WebLinks":{"id":"components/schemas/WebLinks","kind":"json-schema","title":"WebLinks","data":{"type":"object","description":"Web links keyed by subtype. One entry per subtype. Set a value to an empty string to delete that subtype entry.\n","x-tags":["Staffs","Customers"],"properties":{"web":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Primary website URL ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://www.example.com"},"meeting":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Meeting link ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://meet.example.com/john"},"scheduling":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Scheduling link ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://erenyeager7yl0.staging.setmore.com/eren"}}}},"components/schemas/SocialLinks":{"id":"components/schemas/SocialLinks","kind":"json-schema","title":"SocialLinks","data":{"type":"object","description":"Social profile links keyed by subtype. One entry per subtype. Set a value to an empty string to delete that subtype entry.\n","x-tags":["Staffs","Customers"],"properties":{"facebook":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Facebook profile URL ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://facebook.com/john.doe"},"twitter":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Twitter profile URL ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://twitter.com/john_doe"},"youtube":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"YouTube channel URL ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://youtube.com/@john_doe"},"instagram":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Instagram profile URL ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://instagram.com/john_doe"},"skype":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Skype handle, or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"john.doe.skype"},"linkedin":{"type":"string","maxLength":2048,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LinkedIn profile URL ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" URI), or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"\""},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to delete."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://linkedin.com/in/john-doe"}}}},"components/schemas/ContactLocation":{"id":"components/schemas/ContactLocation","kind":"json-schema","title":"ContactLocation","data":{"type":"object","description":"Contact location. At least one field must be non-empty.","x-tags":["Staffs","Customers"],"properties":{"address":{"type":"string","maxLength":1500,"example":"21 Main Street"},"city":{"type":"string","maxLength":1500,"example":"Chennai"},"state":{"type":"string","maxLength":1500,"example":"Tamil Nadu"},"country":{"type":"string","maxLength":1500,"example":"IN"},"zip":{"type":"string","maxLength":1500,"example":"600001"}}}},"components/schemas/CustomFields":{"id":"components/schemas/CustomFields","kind":"json-schema","title":"CustomFields","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Custom fields keyed by field name. Values are user-defined and may be any JSON scalar. Present as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when the contact has none set."},"children":[],"type":"text"}],"type":"paragraph"}],"x-tags":["Staffs","Customers"],"additionalProperties":true,"example":{"DOB":"14/08/1999"}}},"components/schemas/BookingLocationRequest":{"id":"components/schemas/BookingLocationRequest","kind":"json-schema","title":"BookingLocationRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Meeting location of a booking you create."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When to send what"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"You want to…"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"What to send in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A booking "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"with"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" a video meeting"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"type: [\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"video_type: [{ \"type\": \"google-meet\" }]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Providing the provider "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is enough, and the link is generated for you"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A booking "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"without"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" a video meeting"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Leave "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" out"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}],"properties":{"type":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Leave empty (or omit / "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") for no video meeting, or send "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to attach"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"a video meeting. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"videoType"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is the only value allowed."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","enum":["videoType"]},"example":["videoType"]},"video_type":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The video meeting. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", ignored otherwise."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video conferencing provider: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"google-meet"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"zoom"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Providing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"this is enough to have a link generated."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["google-meet","zoom"],"example":"google-meet"}}}}}}},"components/schemas/BookingRequest":{"id":"components/schemas/BookingRequest","kind":"json-schema","title":"BookingRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Booking payload for create ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /bookings"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["type","account_id","provider_id","consumer_ids","service_id","start_at","end_at"],"properties":{"id":{"type":"string","description":"Ignored when creating a booking. The booking id is generated.","example":"bk_123456"},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"What you are booking. It must match the type of the service in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":":"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"APPOINTMENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": a one-to-one booking of a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (a service whose "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SESSION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": a place in a group "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"class"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (a service whose "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). A session"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"holds from 0 up to 50 customers, and never more than the number of seats the class offers"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"(the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"max_seats"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of its service)."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If it does not match, the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400 parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["APPOINTMENT","SESSION"],"example":"APPOINTMENT"},"account_id":{"type":"string","description":"Setmore account id that owns this booking.","example":"acc_123456"},"provider_id":{"type":"string","description":"Id of the staff member assigned to this booking.","example":"provider_123456"},"consumer_ids":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ids of the customers attending this booking."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Appointment:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" send exactly 1 customer."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Session (group class):"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from 0 up to the number of seats the class offers (the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"max_seats"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of its service). To add or remove someone later, use"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/addclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add a customer to a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/removeclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove a customer from a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Any other number of customers is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400 out_of_range"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string"},"example":["cust_123456"]},"service_id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Id of the service or class being booked. Its type must match the booking "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"APPOINTMENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SESSION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"svc_123456"},"start_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Start date/time, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T08:30:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T00:30:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. It is returned in UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T08:30:00+08:00"},"end_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"End date/time, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T09:00:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T01:00:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. It is returned in UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T09:00:00+08:00"},"cost":{"type":"number","format":"double","minimum":0,"maximum":1000000,"default":0,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Cost of the appointment. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"0"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when not provided."},"children":[],"type":"text"}],"type":"paragraph"}],"example":50},"title":{"type":"string","maxLength":255,"default":"","description":"Title of the booking. Defaults to an empty string when not provided.","example":"Consultation"},"notes":{"type":"string","maxLength":1500,"default":"","description":"Notes about the booking. Defaults to an empty string when not provided.","example":"Customer requested a reminder call the day before."},"label":{"type":"string","maxLength":100,"default":"","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Free-text label for the booking, e.g. a status or reminder tag such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RUNNING_LATE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"NO_SHOW"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to an empty string when not provided."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"RUNNING_LATE"},"location":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video meeting for the booking. Providing the provider "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is enough, and the link is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"generated for you."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/BookingLocationRequest"}]},"source":{"type":"string","maxLength":100,"description":"Origin of the booking (e.g. integration name).","example":"booking_page"},"meta_data":{"type":"object","description":"Unstructured key/value passthrough data, with up to 5 entries and each value up to 1500 characters.","maxProperties":5,"default":{},"additionalProperties":{"type":"string","maxLength":1500},"example":{"referred_by":"google_ads"}}}}},"components/schemas/BookingResponse":{"id":"components/schemas/BookingResponse","kind":"json-schema","title":"BookingResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response wrapping a single booking under a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"$ref":"#/components/schemas/Booking"}}}},"components/schemas/ErrorObject":{"id":"components/schemas/ErrorObject","kind":"json-schema","title":"ErrorObject","data":{"type":"object","description":"A single machine-readable error.","required":["code","message"],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Machine-readable error code. One of:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"server_error"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"client_error"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"resource_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"token_expired"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":","},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"missing_authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"unsupported"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":","},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"action_forbidden"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"out_of_range"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":","},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"resource_conflict"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"payload_too_large"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["server_error","client_error","resource_not_found","token_expired","missing_authorization","unsupported","parameter_not_found","parameter_invalid","action_forbidden","out_of_range","resource_conflict","payload_too_large"],"example":"parameter_invalid"},"message":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Human-readable description of the error. When the error originates from"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"a specific field, the field path is included in the message, e.g."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"email_addresses[0].value: must be a valid email address\"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"title is required"}}}},"components/schemas/ErrorsEnvelope":{"id":"components/schemas/ErrorsEnvelope","kind":"json-schema","title":"ErrorsEnvelope","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Envelope for every non-2xx response. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"errors"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is always an array, even when"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"there is exactly one error."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ErrorObject"}}}}},"components/schemas/EventRequest":{"id":"components/schemas/EventRequest","kind":"json-schema","title":"EventRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Event payload for create ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /bookings/events"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). An event is a calendar entry that is not"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"tied to a service, so it has no "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cost"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["type","account_id","provider_id","start_at","end_at","title"],"properties":{"id":{"type":"string","description":"Ignored when creating an event. The event id is generated.","example":"bk_123456"},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Always "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"EVENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["EVENT"],"example":"EVENT"},"account_id":{"type":"string","description":"Setmore account id that owns this event.","example":"acc_123456"},"provider_id":{"type":"string","maxLength":100,"description":"Id of the staff member the event is for.","example":"provider_123456"},"consumer_ids":{"type":"array","description":"Ids of the customers attending the event, up to 10. Optional.","maxItems":10,"items":{"type":"string"},"example":["cust_123456"]},"start_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Start date/time, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T08:30:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T00:30:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. It is returned in UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T08:30:00+08:00"},"end_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"End date/time, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T09:00:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T01:00:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. It is returned in UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T09:00:00+08:00"},"title":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required. Must contain at least one non-whitespace character; an empty or blank title is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"minLength":1,"maxLength":255,"pattern":"\\S","example":"Team lunch"},"notes":{"type":"string","maxLength":1500,"example":"Book a table for six."},"location":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video meeting for the event. Providing the provider "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is enough, and the link is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"generated for you."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/BookingLocationRequest"}]},"source":{"type":"string","maxLength":100,"description":"Origin of the event (e.g. integration name).","example":"booking_page"}}}},"components/schemas/BookingLocationUpdateRequest":{"id":"components/schemas/BookingLocationUpdateRequest","kind":"json-schema","title":"BookingLocationUpdateRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Meeting location of a booking you update."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When to send what"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"You want to…"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"What to send in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keep"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" the meeting unchanged"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Send the booking's existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"location"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" back as it was returned ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"video_type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"link"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" the meeting"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Send an empty object: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"location\": {}"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generate a new"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" meeting"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"type: [\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"video_type: [{ \"type\": \"google-meet\" }]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Providing the provider "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is enough, and the link is generated"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}],"properties":{"type":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Leave empty (or omit / "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") for no video meeting, or send "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to attach"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"a video meeting. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"videoType"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is the only value allowed."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","enum":["videoType"]},"example":["videoType"]},"video_type":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The video meeting. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", ignored otherwise."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/updatebooking"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See the table above"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video conferencing provider: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"google-meet"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"zoom"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Providing"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"this is enough to have a link generated."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["google-meet","zoom"],"example":"google-meet"},"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" returned for the booking's existing video meeting. Send it back, to keep the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"meeting unchanged."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"vid_123456"},"link":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"link"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" returned for the booking's existing video meeting. Send it back, to keep the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"meeting unchanged."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://meet.google.com/abc-defg-hij"}}}}}}},"components/schemas/EventUpdateRequest":{"id":"components/schemas/EventUpdateRequest","kind":"json-schema","title":"EventUpdateRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Event payload for update ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /bookings/events/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the path always wins over"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"any "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" supplied in the body. An event is a calendar entry that is not tied to a service, so"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"it has no "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"cost"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"label"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["type","account_id","provider_id","start_at","end_at","title"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Event id. Optional on update; when sent it must equal the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" path parameter, otherwise the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", \"Invalid id\")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"bk_123456"},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Always "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"EVENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["EVENT"],"example":"EVENT"},"account_id":{"type":"string","description":"Setmore account id that owns this event.","example":"acc_123456"},"provider_id":{"type":"string","maxLength":100,"description":"Id of the staff member the event is for.","example":"provider_123456"},"consumer_ids":{"type":"array","description":"Ids of the customers attending the event, up to 10. Optional, leave it out to keep the current customers.","maxItems":10,"items":{"type":"string"},"example":["cust_123456"]},"start_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Start date/time, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T08:30:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T00:30:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. It is returned in UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T08:30:00+08:00"},"end_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"End date/time, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T09:00:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T01:00:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. It is returned in UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T09:00:00+08:00"},"title":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required. Must contain at least one non-whitespace character; an empty or blank title is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"minLength":1,"maxLength":255,"pattern":"\\S","example":"Team lunch"},"notes":{"type":"string","maxLength":1500,"example":"Book a table for six."},"location":{"description":"Video meeting for the event. See the table for what to send to keep, remove or\ngenerate a meeting.\n","allOf":[{"$ref":"#/components/schemas/BookingLocationUpdateRequest"}]},"source":{"type":"string","maxLength":100,"description":"Origin of the event (e.g. integration name). Optional on update; leave it out to keep the stored value.","example":"booking_page"}}}},"components/schemas/BookingUpdateRequest":{"id":"components/schemas/BookingUpdateRequest","kind":"json-schema","title":"BookingUpdateRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Booking payload for update ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /bookings/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the path always wins over any "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" supplied in the body."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["type","account_id","provider_id","consumer_ids","service_id","start_at","end_at"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Booking id. Optional on update; when sent it must equal the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" path parameter, otherwise the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", \"Invalid id\")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"bk_123456"},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"What you are booking. It must match the type of the service in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":":"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"APPOINTMENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": a one-to-one booking of a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (a service whose "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SESSION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": a place in a group "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"class"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (a service whose "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). A session"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"holds from 0 up to 50 customers, and never more than the number of seats the class offers"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"(the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"max_seats"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of its service)."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If it does not match, the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400 parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The type of an existing booking can't be changed on update."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["APPOINTMENT","SESSION"],"example":"APPOINTMENT"},"account_id":{"type":"string","description":"Setmore account id that owns this booking.","example":"acc_123456"},"provider_id":{"type":"string","description":"Id of the staff member assigned to this booking.","example":"provider_123456"},"consumer_ids":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ids of the customers attending this booking."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Appointment:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" send exactly 1 customer."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Session (group class):"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from 0 up to the number of seats the class offers (the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"max_seats"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of its service). When you update a session you can only send back the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"customers already in it, unchanged. To add or remove someone later, use"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/addclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Add a customer to a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/bookings/removeclassattendee"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Remove a customer from a class session"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Any other number of customers is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400 out_of_range"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string"},"example":["cust_123456"]},"service_id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Id of the service or class being booked. Its type must match the booking "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"APPOINTMENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SESSION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"svc_123456"},"start_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Start date/time, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T08:30:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T00:30:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. It is returned in UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T08:30:00+08:00"},"end_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"End date/time, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. For example, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T09:00:00+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026-11-19T01:00:00Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are the same moment. It is returned in UTC."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T09:00:00+08:00"},"cost":{"type":"number","format":"double","minimum":0,"maximum":1000000,"default":0,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Cost of the appointment. Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"0"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when not provided."},"children":[],"type":"text"}],"type":"paragraph"}],"example":50},"title":{"type":"string","maxLength":255,"default":"","description":"Title of the booking. Defaults to an empty string when not provided.","example":"Consultation"},"notes":{"type":"string","maxLength":1500,"default":"","description":"Notes about the booking. Defaults to an empty string when not provided.","example":"Customer requested a reminder call the day before."},"label":{"type":"string","maxLength":100,"default":"","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Free-text label for the booking, e.g. a status or reminder tag such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RUNNING_LATE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"NO_SHOW"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Defaults to an empty string when not provided."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"RUNNING_LATE"},"location":{"description":"Video meeting for the booking. See the table for what to send to keep, remove or\ngenerate a meeting.\n","allOf":[{"$ref":"#/components/schemas/BookingLocationUpdateRequest"}]},"source":{"type":"string","maxLength":100,"description":"Origin of the booking (e.g. integration name).","example":"booking_page"},"meta_data":{"type":"object","description":"Unstructured key/value passthrough data, with up to 5 entries and each value up to 1500 characters.","maxProperties":5,"default":{},"additionalProperties":{"type":"string","maxLength":1500},"example":{"referred_by":"google_ads"}}}}},"components/schemas/BookingListResponse":{"id":"components/schemas/BookingListResponse","kind":"json-schema","title":"BookingListResponse","data":{"type":"object","description":"Response for booking list operations.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Booking"}},"cursor":{"type":"string","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page. Omitted entirely when there is no next page.","example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9"}}}},"components/schemas/SlotsResponse":{"id":"components/schemas/SlotsResponse","kind":"json-schema","title":"SlotsResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response wrapping the slots under a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"$ref":"#/components/schemas/Slots"}}}},"components/schemas/ClassSlotsResponse":{"id":"components/schemas/ClassSlotsResponse","kind":"json-schema","title":"ClassSlotsResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response wrapping the class sessions under a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"$ref":"#/components/schemas/ClassSlots"}}}},"components/schemas/CategoryListResponse":{"id":"components/schemas/CategoryListResponse","kind":"json-schema","title":"CategoryListResponse","data":{"type":"object","description":"Response for category list operations.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"cursor":{"type":"string","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page. Omitted entirely when there is no next page.","example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9"}}}},"components/schemas/CategoryRequest":{"id":"components/schemas/CategoryRequest","kind":"json-schema","title":"CategoryRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category payload for create ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /categories"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") and update ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /categories/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"On update, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in the path always wins over any "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" supplied in the body."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["account_id","title","service_ids"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category id. Ignored on update. The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" path parameter is authoritative."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"cat_123456"},"account_id":{"type":"string","description":"Setmore account id that owns this category.","example":"acc_123456"},"description":{"type":"string","maxLength":1500,"description":"Description of the category.","example":"Standard haircut services"},"title":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required. Must contain at least one non-whitespace character; an empty or blank title is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"minLength":1,"maxLength":255,"example":"Haircuts"},"service_ids":{"type":"array","description":"Service id(s) belonging to this category.","maxItems":100,"items":{"type":"string"},"example":["svc_123456"]},"color_code":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Hex color code, e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"#FF5733"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"pattern":"^#[0-9A-Fa-f]{6}$","maxLength":7,"example":"#FF5733"},"image_url":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"URL of the image shown for the category. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for URI syntax."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://cdn.example.com/categories/haircuts.png"},"visibility":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Visibility of the category ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUBLIC"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PRIVATE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"UNAVAILABLE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUBLIC"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when not provided."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["PUBLIC","PRIVATE","UNAVAILABLE"],"default":"PUBLIC","example":"PUBLIC"}}}},"components/schemas/CategoryResponse":{"id":"components/schemas/CategoryResponse","kind":"json-schema","title":"CategoryResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response wrapping a single category under a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"$ref":"#/components/schemas/Category"}}}},"components/schemas/ServiceListResponse":{"id":"components/schemas/ServiceListResponse","kind":"json-schema","title":"ServiceListResponse","data":{"type":"object","description":"Response for service list operations.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"cursor":{"type":"string","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page. Omitted entirely when there is no next page.","example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9"}}}},"components/schemas/ServiceLocationRequest":{"id":"components/schemas/ServiceLocationRequest","kind":"json-schema","title":"ServiceLocationRequest","data":{"type":"object","description":"Where the service is delivered, for a service you create or update.","properties":{"type":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Leave empty (or omit / "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") for no video meeting, or send "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to attach"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"a video meeting. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"videoType"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is the only value allowed."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","enum":["videoType"]},"example":["videoType"]},"video_type":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The video meeting. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"[\"videoType\"]"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; ignored otherwise."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","required":["type","is_default"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Video conferencing provider: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"google-meet"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"zoom"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["google-meet","zoom"],"example":"google-meet"},"is_default":{"type":"boolean","description":"Whether this is the default video meeting for the service.","example":true}}}}}}},"components/schemas/ServiceRequest":{"id":"components/schemas/ServiceRequest","kind":"json-schema","title":"ServiceRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Service payload for create ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /services"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":") and update"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /services/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). On update, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" supplied in the body must match"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" path parameter."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A service is priced in the Setmore account's currency, so the request has no "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"currency"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"property: sending one is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["account_id","title","type","duration"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Service id. Optional on update; when sent it must equal the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" path parameter, otherwise the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", \"Invalid id\")."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"svc_123456"},"account_id":{"type":"string","description":"Setmore account that owns this service.","example":"acc_123456"},"title":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required. Must contain at least one non-whitespace character; an empty or blank title is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_not_found"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"minLength":1,"maxLength":255,"pattern":"\\S","example":"30 min consultation"},"provider_ids":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Staff member id(s) who can be booked for this service. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required, with at least one id, when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; optional for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Omitting it, sending "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or sending an empty array for a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each id must be a real id: a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", empty or blank id, or the text "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", is rejected"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"maxItems":100,"items":{"type":"string"},"example":["provider_123456"]},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Whether this is a one-to-one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or a group "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The type cannot be changed after the service is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"created: an update with a different "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["SERVICE","CLASS"],"example":"SERVICE"},"max_seats":{"type":"integer","minimum":1,"maximum":50,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Seat capacity of the class. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Required when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; ignored"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":10},"cost":{"type":"number","format":"float","minimum":0,"maximum":1000000,"description":"Cost of the service, in the currency of the Setmore account.","example":50},"duration":{"type":"integer","minimum":1,"maximum":1439,"description":"Meeting duration in minutes.","example":30},"color_code":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Hex color code used to display the service, e.g. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"#4287f5"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"pattern":"^#[0-9A-Fa-f]{6}$","maxLength":7,"example":"#4287f5"},"buffer":{"type":"object","description":"Buffer time, in minutes, kept free before and after the meeting.","properties":{"before":{"type":"integer","minimum":0,"maximum":1439,"description":"Buffer time in minutes before the meeting.","example":5},"after":{"type":"integer","minimum":0,"maximum":1439,"description":"Buffer time in minutes after the meeting.","example":5}}},"visibility":{"type":"string","enum":["PUBLIC","PRIVATE","UNAVAILABLE"],"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Visibility of the service ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUBLIC"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PRIVATE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"UNAVAILABLE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). Defaults to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUBLIC"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when not provided."},"children":[],"type":"text"}],"type":"paragraph"}],"default":"PUBLIC"},"location":{"$ref":"#/components/schemas/ServiceLocationRequest"},"category_ids":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Id(s) of the categories this service belongs to."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Every id must be an existing category of the Setmore account, and an id must not appear more than once."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Otherwise the request is rejected with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"400"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter_invalid"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The service is always added to the account's default category for its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"All Services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"All Class Bookings"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLASS"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". It is added when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"category_ids"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is empty or"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"omitted, and when it is missing from the list. A default category you list yourself is not repeated."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"On update the list replaces the service's categories (the default category stays)."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"maxItems":50,"items":{"type":"string"},"example":["cat_123456"]}}}},"components/schemas/ServiceResponse":{"id":"components/schemas/ServiceResponse","kind":"json-schema","title":"ServiceResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response wrapping a single service under a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"$ref":"#/components/schemas/Service"}}}},"components/schemas/ServiceProviderRequest":{"id":"components/schemas/ServiceProviderRequest","kind":"json-schema","title":"ServiceProviderRequest","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Assigns or unassigns providers (staff members) to/from the service"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"identified by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" path parameter ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /services/provider/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"assign":{"type":"array","description":"Provider (staff member) id(s) to assign to this service.","maxItems":100,"items":{"type":"string"},"example":["provider_123456"]},"un_assign":{"type":"array","description":"Provider (staff member) id(s) to unassign from this service.","maxItems":100,"items":{"type":"string"},"example":["provider_789012"]}}}},"components/schemas/WorkingHoursListResponse":{"id":"components/schemas/WorkingHoursListResponse","kind":"json-schema","title":"WorkingHoursListResponse","data":{"type":"object","description":"Response for working-hours list operations.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkingHours"}},"cursor":{"type":"string","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page. Omitted entirely when there is no next page.","example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9"}}}},"components/schemas/WorkingHoursResponse":{"id":"components/schemas/WorkingHoursResponse","kind":"json-schema","title":"WorkingHoursResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response wrapping a single staff member's working hours under a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"$ref":"#/components/schemas/WorkingHours"}}}},"components/schemas/ContactListResponse":{"id":"components/schemas/ContactListResponse","kind":"json-schema","title":"ContactListResponse","data":{"type":"object","description":"Response for list operations returning multiple contacts.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"cursor":{"type":"string","description":"Opaque pagination cursor. Pass the value from the previous response to fetch the next page. Omitted from the response entirely when no more pages are available.","example":"ClASSmoVc35zdGFnaW5nLWNvbnRhY3RzYXBpcjELEgdDb250YWN0IiQyZmZhYWM0YS01MjgyLTQ2MWUtYWNlYS0yMDQ1MmQzYWFkNTkMGAAgAA=="}}}},"components/schemas/ContactResponse":{"id":"components/schemas/ContactResponse","kind":"json-schema","title":"ContactResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response wrapping a single contact under a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"$ref":"#/components/schemas/Contact"}}}},"components/schemas/ContactRequest":{"id":"components/schemas/ContactRequest","kind":"json-schema","title":"ContactRequest","data":{"type":"object","description":"Request model for creating or updating a contact.","properties":{"first_name":{"type":"string","maxLength":1500,"example":"John"},"last_name":{"type":"string","maxLength":1500,"example":"Doe"},"avatar_url":{"type":"string","format":"uri","maxLength":1500,"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3986"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3986"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for URI syntax."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"https://avatar.example.com/john"},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/ContactMethodEntry"},"maxItems":10,"description":"Email entries to add, update, or delete. Maximum 10 per contact. Duplicate email values (case-insensitive) are silently ignored.\n"},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/ContactMethodEntry"},"maxItems":10,"description":"Phone entries to add, update, or delete. Maximum 10 per contact. Duplicate phone values are silently ignored.\n"},"urls":{"$ref":"#/components/schemas/WebLinks"},"social":{"$ref":"#/components/schemas/SocialLinks"},"location":{"$ref":"#/components/schemas/ContactLocation"},"custom_fields":{"$ref":"#/components/schemas/CustomFields"}}}},"components/schemas/BulkCreateResultItem":{"id":"components/schemas/BulkCreateResultItem","kind":"json-schema","title":"BulkCreateResultItem","data":{"type":"object","required":["index","status"],"description":"Result for a single item in a bulk create operation. On success: index, status, and data are present. On failure: index, status, and error are present.\n","properties":{"index":{"type":"integer","description":"Zero-based position of this item in the request array.","example":0},"status":{"type":"integer","description":"HTTP status code for this individual item.","example":201},"data":{"$ref":"#/components/schemas/Contact"},"error":{"$ref":"#/components/schemas/ErrorObject"}}}},"components/schemas/BulkCreateContactResponse":{"id":"components/schemas/BulkCreateContactResponse","kind":"json-schema","title":"BulkCreateContactResponse","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response for bulk create operations. Uses partial-success semantics: each item reports its own status independently under "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreateResultItem"}}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","example":"bk_123456"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","example":"staff_123456"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Start of the range, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. URL-encode the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"%2B"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-01-20T00:00:00Z"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"End of the range, in the same format as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-01-27T00:00:00Z"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","example":"eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":100,"example":100},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","example":"cust_123456"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","example":"evt_123456"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","example":"acc_123456"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","example":"provider_123456"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":1439,"example":30},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Start of the range, an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"RFC 3339"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"date-time"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with an offset: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Z"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for UTC or a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"numeric offset such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+08:00"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", in whole seconds. URL-encode the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"+"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"%2B"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-19T00:00:00+08:00"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"End of the range, in the same format as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"start_at"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2026-11-25T00:00:00+08:00"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iana.org/time-zones"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IANA Time Zone Database"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" identifier. The slot times in the response use the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"offset of this time zone."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"Asia/Singapore"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":15,"example":15},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"boolean","default":false,"example":false},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","example":"svc_123456"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iana.org/time-zones"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IANA Time Zone Database"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" identifier."},"children":[],"type":"text"}],"type":"paragraph"}],"default":"UTC","example":"America/New_York"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","example":"cat_123456"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"string","example":"ClASSmoVc35zdGFnaW5nLWNvbnRhY3RzYXBpcjELEgdDb250YWN0IiQyZmZhYWM0YS01MjgyLTQ2MWUtYWNlYS0yMDQ1MmQzYWFkNTkMGAAgAA=="},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":25,"example":25},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","example":"160018e3-57a6-480b-9811-9ac25b42501f"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","example":"Cm4KHAoPbGFzdFVwZGF0ZWREYXRlEgkIuPWz3P-HkwMSSmoVc35zdGFnaW5nLWNvbnRhY3RzYXBpcjELEgdDb250YWN0IiQ0M2Y3MjliOS04MDMxLTRjNWYtODMzYS04Yjg5OWRhMzYxNzAMGAAgAQ=="},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string","example":"eaafecfe-8c33-428a-88bd-ba4d012793aa"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/ContactRequest"}},"id":"schema_24"}},"exampleStore":{"paths/~1bookings/post/responses/200/content/application~1json/examples/created":{"value":{"data":{"id":"bk_123456","type":"APPOINTMENT","calendar_id":"cal_123456","account_id":"acc_123456","provider_id":"provider_123456","consumer_ids":["cust_123456"],"service_id":"svc_123456","start_at":"2026-01-20T09:00:00Z","end_at":"2026-01-20T10:00:00Z","status":"CONFIRMED"}},"key":"created","summary":"Booking created","id":"paths/~1bookings/post/responses/200/content/application~1json/examples/created"},"paths/~1bookings/post/responses/400/content/application~1json/examples/typeMismatch":{"value":{"errors":[{"code":"parameter_invalid","message":"The booking type does not match the service id: a booking of type SESSION needs a service of type CLASS, but 'svc_123456' is of type SERVICE."}]},"key":"typeMismatch","summary":"Booking type does not match the service","id":"paths/~1bookings/post/responses/400/content/application~1json/examples/typeMismatch"},"paths/~1bookings/post/responses/400/content/application~1json/examples/customerCount":{"value":{"errors":[{"code":"out_of_range","message":"'consumer_ids' must contain exactly 1 customer for an APPOINTMENT"}]},"key":"customerCount","summary":"Wrong number of customers for the booking type","id":"paths/~1bookings/post/responses/400/content/application~1json/examples/customerCount"},"paths/~1bookings/post/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings/post/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings/post/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings/post/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings/post/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1bookings/post/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1bookings/post/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings/post/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1events/post/responses/200/content/application~1json/examples/created":{"value":{"data":{"id":"bk_123456","type":"EVENT","calendar_id":"acc_123456","account_id":"acc_123456","provider_id":"provider_123456","consumer_ids":["cust_123456"],"title":"Team lunch","start_at":"2026-01-20T09:00:00Z","end_at":"2026-01-20T10:00:00Z","status":"CONFIRMED"}},"key":"created","summary":"Event created","id":"paths/~1bookings~1events/post/responses/200/content/application~1json/examples/created"},"paths/~1bookings~1events/post/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1events/post/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1events/post/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1events/post/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1events/post/responses/405/content/application~1json/examples/unsupportedFields":{"value":{"errors":[{"code":"unsupported","message":"Operation not supported: an event does not support service_id, cost. Remove them from the request."}]},"key":"unsupportedFields","summary":"Fields an event does not support","id":"paths/~1bookings~1events/post/responses/405/content/application~1json/examples/unsupportedFields"},"paths/~1bookings~1events/post/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1bookings~1events/post/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1bookings~1events/post/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1events/post/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1events~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/unknownId"},"paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1bookings~1events~1{id}/put/responses/404/content/application~1json/examples/notFound"},"paths/~1bookings~1events~1{id}/put/responses/405/content/application~1json/examples/unsupportedFields":{"value":{"errors":[{"code":"unsupported","message":"Operation not supported: an event does not support service_id, cost. Remove them from the request."}]},"key":"unsupportedFields","summary":"Fields an event does not support","id":"paths/~1bookings~1events~1{id}/put/responses/405/content/application~1json/examples/unsupportedFields"},"paths/~1bookings~1events~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1bookings~1events~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1bookings~1events~1{id}/put/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1events~1{id}/put/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1{id}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"You do not have permission to access this resource"}]},"key":"forbidden","summary":"Merchant does not own this resource","id":"paths/~1bookings~1{id}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/unknownId"},"paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1bookings~1{id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1bookings~1{id}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1{id}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/typeMismatch":{"value":{"errors":[{"code":"parameter_invalid","message":"The booking type does not match the service id: a booking of type SESSION needs a service of type CLASS, but 'svc_123456' is of type SERVICE."}]},"key":"typeMismatch","summary":"Booking type does not match the service","id":"paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/typeMismatch"},"paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/customerCount":{"value":{"errors":[{"code":"out_of_range","message":"'consumer_ids' must contain exactly 1 customer for an APPOINTMENT"}]},"key":"customerCount","summary":"Wrong number of customers for the booking type","id":"paths/~1bookings~1{id}/put/responses/400/content/application~1json/examples/customerCount"},"paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/unknownId"},"paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1bookings~1{id}/put/responses/404/content/application~1json/examples/notFound"},"paths/~1bookings~1{id}/put/responses/405/content/application~1json/examples/sessionCustomersLocked":{"value":{"errors":[{"code":"unsupported","message":"Operation not supported: the customers of a session cannot be changed by updating the booking. Use the add customer to session or remove customer from session API instead."}]},"key":"sessionCustomersLocked","summary":"Customers of a session can't be changed here","id":"paths/~1bookings~1{id}/put/responses/405/content/application~1json/examples/sessionCustomersLocked"},"paths/~1bookings~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1bookings~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1bookings~1{id}/put/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1{id}/put/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/unknownId"},"paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1bookings~1{id}/delete/responses/404/content/application~1json/examples/notFound"},"paths/~1bookings~1{id}/delete/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1{id}/delete/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/required"},"paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1bookings~1staffs~1{id}/get/responses/400/content/application~1json/examples/validationFailed"},"paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/required"},"paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1bookings~1customers~1{id}/get/responses/400/content/application~1json/examples/validationFailed"},"paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/unknownId"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/404/content/application~1json/examples/notFound"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/alreadyInSession":{"value":{"errors":[{"code":"resource_conflict","message":"The customer is already in this session."}]},"key":"alreadyInSession","summary":"Customer already in the session","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/alreadyInSession"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/sessionFull":{"value":{"errors":[{"code":"resource_conflict","message":"The session is full."}]},"key":"sessionFull","summary":"No seats left","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/409/content/application~1json/examples/sessionFull"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/post/responses/500/content/application~1json/examples/internalError"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"notFound","summary":"Session or attendee not found","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/404/content/application~1json/examples/notFound"},"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1bookings~1class~1{session-id}~1attendees~1{customer-id}/delete/responses/500/content/application~1json/examples/internalError"},"paths/~1slots/get/responses/400/content/application~1json/examples/rangeExceeded":{"value":{"errors":[{"code":"out_of_range","message":"Date range must not exceed 7 days"}]},"key":"rangeExceeded","summary":"Date range exceeds 7 days","id":"paths/~1slots/get/responses/400/content/application~1json/examples/rangeExceeded"},"paths/~1slots/get/responses/400/content/application~1json/examples/unknownStaff":{"value":{"errors":[{"code":"parameter_invalid","message":"'provider_id' is not a valid staff id"}]},"key":"unknownStaff","summary":"Unknown staff id","id":"paths/~1slots/get/responses/400/content/application~1json/examples/unknownStaff"},"paths/~1slots/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1slots/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1slots/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1slots/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1slots/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1slots/get/responses/500/content/application~1json/examples/internalError"},"paths/~1slots~1class~1{class-key}/get/responses/400/content/application~1json/examples/invalidTimezone":{"value":{"errors":[{"code":"parameter_invalid","message":"'timezone' must be a valid IANA time zone identifier"}]},"key":"invalidTimezone","summary":"Unknown time zone","id":"paths/~1slots~1class~1{class-key}/get/responses/400/content/application~1json/examples/invalidTimezone"},"paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1slots~1class~1{class-key}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/unknownId"},"paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1slots~1class~1{class-key}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1slots~1class~1{class-key}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1slots~1class~1{class-key}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1categories/get/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1categories/get/responses/400/content/application~1json/examples/required"},"paths/~1categories/get/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1categories/get/responses/400/content/application~1json/examples/validationFailed"},"paths/~1categories/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1categories/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1categories/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1categories/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1categories/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1categories/get/responses/500/content/application~1json/examples/internalError"},"paths/~1categories/post/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1categories/post/responses/400/content/application~1json/examples/required"},"paths/~1categories/post/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1categories/post/responses/400/content/application~1json/examples/validationFailed"},"paths/~1categories/post/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1categories/post/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1categories/post/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1categories/post/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1categories/post/responses/409/content/application~1json/examples/duplicateTitle":{"value":{"errors":[{"code":"resource_conflict","message":"A category with this title already exists. Please use a different title."}]},"key":"duplicateTitle","summary":"Category title already in use","id":"paths/~1categories/post/responses/409/content/application~1json/examples/duplicateTitle"},"paths/~1categories/post/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1categories/post/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1categories/post/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1categories/post/responses/500/content/application~1json/examples/internalError"},"paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1categories~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1categories~1{id}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"You do not have permission to access this resource"}]},"key":"forbidden","summary":"Merchant does not own this resource","id":"paths/~1categories~1{id}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/unknownId"},"paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1categories~1{id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1categories~1{id}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1categories~1{id}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/required"},"paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1categories~1{id}/put/responses/400/content/application~1json/examples/validationFailed"},"paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1categories~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/unknownId"},"paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1categories~1{id}/put/responses/404/content/application~1json/examples/notFound"},"paths/~1categories~1{id}/put/responses/409/content/application~1json/examples/duplicateTitle":{"value":{"errors":[{"code":"resource_conflict","message":"A category with this title already exists. Please use a different title."}]},"key":"duplicateTitle","summary":"Category title already in use","id":"paths/~1categories~1{id}/put/responses/409/content/application~1json/examples/duplicateTitle"},"paths/~1categories~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1categories~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1categories~1{id}/put/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1categories~1{id}/put/responses/500/content/application~1json/examples/internalError"},"paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1categories~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/unknownId"},"paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1categories~1{id}/delete/responses/404/content/application~1json/examples/notFound"},"paths/~1categories~1{id}/delete/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1categories~1{id}/delete/responses/500/content/application~1json/examples/internalError"},"paths/~1services/get/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1services/get/responses/400/content/application~1json/examples/required"},"paths/~1services/get/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1services/get/responses/400/content/application~1json/examples/validationFailed"},"paths/~1services/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1services/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1services/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1services/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1services/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1services/get/responses/500/content/application~1json/examples/internalError"},"paths/~1services/post/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1services/post/responses/400/content/application~1json/examples/required"},"paths/~1services/post/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1services/post/responses/400/content/application~1json/examples/validationFailed"},"paths/~1services/post/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1services/post/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1services/post/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1services/post/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1services/post/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1services/post/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1services/post/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1services/post/responses/500/content/application~1json/examples/internalError"},"paths/~1services~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1services~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1services~1{id}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1services~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1services~1{id}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"You do not have permission to access this resource"}]},"key":"forbidden","summary":"Merchant does not own this resource","id":"paths/~1services~1{id}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1services~1{id}/get/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1services~1{id}/get/responses/404/content/application~1json/examples/unknownId"},"paths/~1services~1{id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1services~1{id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1services~1{id}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1services~1{id}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1services~1{id}/put/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1services~1{id}/put/responses/400/content/application~1json/examples/required"},"paths/~1services~1{id}/put/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1services~1{id}/put/responses/400/content/application~1json/examples/validationFailed"},"paths/~1services~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1services~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1services~1{id}/put/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1services~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1services~1{id}/put/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1services~1{id}/put/responses/404/content/application~1json/examples/unknownId"},"paths/~1services~1{id}/put/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1services~1{id}/put/responses/404/content/application~1json/examples/notFound"},"paths/~1services~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1services~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1services~1{id}/put/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1services~1{id}/put/responses/500/content/application~1json/examples/internalError"},"paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1services~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/unknownId"},"paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1services~1{id}/delete/responses/404/content/application~1json/examples/notFound"},"paths/~1services~1{id}/delete/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1services~1{id}/delete/responses/500/content/application~1json/examples/internalError"},"paths/~1services~1provider~1{id}/put/responses/400/content/application~1json/examples/providerNotFound":{"value":{"errors":[{"code":"resource_not_found","message":"Provider provider_999999 in 'assign' does not exist for this account"}]},"key":"providerNotFound","summary":"Provider id in assign/un_assign does not exist","id":"paths/~1services~1provider~1{id}/put/responses/400/content/application~1json/examples/providerNotFound"},"paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1services~1provider~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/unknownId"},"paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1services~1provider~1{id}/put/responses/404/content/application~1json/examples/notFound"},"paths/~1services~1provider~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1services~1provider~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1services~1provider~1{id}/put/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1services~1provider~1{id}/put/responses/500/content/application~1json/examples/internalError"},"paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/required":{"value":{"errors":[{"code":"parameter_not_found","message":"title is mandatory"}]},"key":"required","summary":"Missing required field","id":"paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/required"},"paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"'limit' must be between 1 and 100"}]},"key":"validationFailed","summary":"Field-level validation failure","id":"paths/~1working-hours~1staffs/get/responses/400/content/application~1json/examples/validationFailed"},"paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1working-hours~1staffs/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1working-hours~1staffs/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1working-hours~1staffs/get/responses/500/content/application~1json/examples/internalError"},"paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1working-hours~1staffs~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/unknownId"},"paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1working-hours~1staffs~1{id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1working-hours~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1working-hours~1staffs~1{id}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1staff/get/responses/200/content/application~1json/examples/staffList":{"value":{"data":[{"id":"160018e3-57a6-480b-9811-9ac25b42501f","first_name":"Eren","last_name":"Yeager","phone_numbers":[{"id":"1b79a8aa-6833-41c0-9424-8267910a193c","value":"+919944422112","primary":true}],"email_addresses":[{"id":"20cb5d9a-54cf-445e-8748-fd47aa765b58","value":"eren.yeager221@gmail.com","primary":true}],"urls":{"scheduling":"https://erenyeager7yl0.staging.setmore.com/eren"}}],"cursor":"ClASSmoVc35zdGFnaW5nLWNvbnRhY3RzYXBpcjELEgdDb250YWN0IiQyZmZhYWM0YS01MjgyLTQ2MWUtYWNlYS0yMDQ1MmQzYWFkNTkMGAAgAA=="},"key":"staffList","summary":"List of staff contacts with pagination","id":"paths/~1staff/get/responses/200/content/application~1json/examples/staffList"},"paths/~1staff/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1staff/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1staff/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1staff/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1staff/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1staff/get/responses/500/content/application~1json/examples/internalError"},"paths/~1staff~1{id}/get/responses/200/content/application~1json/examples/staffContactDetails":{"value":{"data":{"id":"160018e3-57a6-480b-9811-9ac25b42501f","first_name":"Eren","last_name":"Yeager","phone_numbers":[{"id":"1b79a8aa-6833-41c0-9424-8267910a193c","value":"+919944422112","primary":true}],"email_addresses":[{"id":"20cb5d9a-54cf-445e-8748-fd47aa765b58","value":"eren.yeager221@gmail.com","primary":true}],"urls":{"scheduling":"https://erenyeager7yl0.staging.setmore.com/eren"}}},"key":"staffContactDetails","summary":"Complete staff contact details","id":"paths/~1staff~1{id}/get/responses/200/content/application~1json/examples/staffContactDetails"},"paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1staff~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1staff~1{id}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"The contact does not belong to the specified account"}]},"key":"forbidden","summary":"Contact does not belong to the caller's account","id":"paths/~1staff~1{id}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/unknownId"},"paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1staff~1{id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1staff~1{id}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1staff~1{id}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1customers/get/responses/200/content/application~1json/examples/customerList":{"value":{"data":[{"id":"c07b265f-f56e-447f-8c7a-5a407486fd95","first_name":"John","last_name":"Doe","avatar_url":"https://avatar.example.com/john","phone_numbers":[{"id":"6cc3a411-81cf-4bf1-bad1-404dc57dd283","value":"+918833993399","primary":true}],"email_addresses":[{"id":"4d2ac297-84fd-4150-935b-d488a83ac76d","value":"john.doe@gmail.com","primary":true}],"location":{"country":"IN","state":"Tamil Nadu","city":"Chennai","address":"21 street"}}],"cursor":"Cm4KHAoPbGFzdFVwZGF0ZWREYXRlEgkIuPWz3P-HkwMSSmoVc35zdGFnaW5nLWNvbnRhY3RzYXBpcjELEgdDb250YWN0IiQ0M2Y3MjliOS04MDMxLTRjNWYtODMzYS04Yjg5OWRhMzYxNzAMGAAgAQ=="},"key":"customerList","summary":"List of customer contacts with pagination","id":"paths/~1customers/get/responses/200/content/application~1json/examples/customerList"},"paths/~1customers/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1customers/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1customers/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1customers/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1customers/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1customers/get/responses/500/content/application~1json/examples/internalError"},"paths/~1customers/post/requestBody/content/application~1json/examples/createWithMultipleEmailsAndPhones":{"value":{"first_name":"John","last_name":"Doe","avatar_url":"https://avatar.example.com/john","email_addresses":[{"value":"primary@gmail.com","primary":true},{"value":"secondary@gmail.com"}],"phone_numbers":[{"value":"+919399339922","primary":true},{"value":"+919399339923"}],"urls":{"meeting":"https://meet.example.com/john"},"social":{"facebook":"https://facebook.com/john","linkedin":"https://linkedin.com/in/john"},"location":{"address":"123 Main St","city":"Chennai"},"custom_fields":{"DOB":"12/08/1999"}},"key":"createWithMultipleEmailsAndPhones","summary":"Create contact with multiple emails, phones, url, and social","id":"paths/~1customers/post/requestBody/content/application~1json/examples/createWithMultipleEmailsAndPhones"},"paths/~1customers/post/responses/201/content/application~1json/examples/created":{"value":{"data":{"id":"eaafecfe-8c33-428a-88bd-ba4d012793aa","first_name":"John","last_name":"Doe","avatar_url":"https://avatar.example.com/john","phone_numbers":[{"id":"cef8225c-e33c-4abb-a667-3accf8bd72f8","value":"+918839339933","primary":true}],"email_addresses":[{"id":"ac863d99-db4c-4a70-a9f2-0bfb9cc4713e","value":"john.doe@gmail.com","primary":true}],"urls":{"meeting":"https://meet.example.com/john"},"social":{"facebook":"https://facebook.com/john"},"location":{"city":"Chennai","address":"123 Main St"},"custom_fields":{"DOB":"12/08/1999"}}},"key":"created","summary":"Successfully created contact","id":"paths/~1customers/post/responses/201/content/application~1json/examples/created"},"paths/~1customers/post/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"email_addresses: must be a valid email address"},{"code":"parameter_invalid","message":"phone_numbers: must be a valid phone number"},{"code":"parameter_invalid","message":"email_addresses: maximum of 10 emails allowed per contact; current total would be 21"}]},"key":"validationFailed","summary":"Validation errors with invalid email/phone, plus limit exceeded","id":"paths/~1customers/post/responses/400/content/application~1json/examples/validationFailed"},"paths/~1customers/post/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1customers/post/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1customers/post/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1customers/post/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1customers/post/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"Cannot create a contact under an internal account"}]},"key":"forbidden","summary":"Cannot create a contact under an internal account","id":"paths/~1customers/post/responses/403/content/application~1json/examples/forbidden"},"paths/~1customers/post/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1customers/post/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1customers/post/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1customers/post/responses/500/content/application~1json/examples/internalError"},"paths/~1customers~1{id}/get/responses/200/content/application~1json/examples/contactDetails":{"value":{"data":{"id":"eaafecfe-8c33-428a-88bd-ba4d012793aa","first_name":"Henry","last_name":"Doe","avatar_url":"https://avatar.example.com/henry","phone_numbers":[{"id":"cef8225c-e33c-4abb-a667-3accf8bd72f8","value":"+918839339933","primary":true}],"email_addresses":[{"id":"ac863d99-db4c-4a70-a9f2-0bfb9cc4713e","value":"john.doe@gmail.com","primary":true}],"urls":{"meeting":"https://meet.example.com/john.doe"},"social":{"facebook":"https://facebook.com/john.doe"},"location":{"country":"IN","state":"Tamil Nadu","city":"Chennai","address":"21 street"},"custom_fields":{"DOB":"14/08/1999"}}},"key":"contactDetails","summary":"Complete customer contact details","id":"paths/~1customers~1{id}/get/responses/200/content/application~1json/examples/contactDetails"},"paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1customers~1{id}/get/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1customers~1{id}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"The contact does not belong to the specified account"}]},"key":"forbidden","summary":"Contact does not belong to the caller's account","id":"paths/~1customers~1{id}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/unknownId"},"paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1customers~1{id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1customers~1{id}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1customers~1{id}/put/requestBody/content/application~1json/examples/updateWithDeleteAndAdd":{"value":{"first_name":"John","last_name":"Doe","email_addresses":[{"value":"newemail@gmail.com","primary":true},{"id":"em_102","deleted":true}],"phone_numbers":[{"id":"ph_201","value":"+919399339900"},{"id":"ph_202","deleted":true}],"urls":{"meeting":"https://meet.example.com/john-updated","scheduling":""},"social":{"facebook":"","instagram":"https://instagram.com/john"},"location":{"address":"456 New Address","city":"Mumbai"}},"key":"updateWithDeleteAndAdd","summary":"Update contact: add, update, and delete emails/phones; update url/social","id":"paths/~1customers~1{id}/put/requestBody/content/application~1json/examples/updateWithDeleteAndAdd"},"paths/~1customers~1{id}/put/responses/200/content/application~1json/examples/updated":{"value":{"data":{"id":"eaafecfe-8c33-428a-88bd-ba4d012793aa","first_name":"Henry","last_name":"Doe","phone_numbers":[{"id":"cef8225c-e33c-4abb-a667-3accf8bd72f8","value":"+918839339933","primary":true}],"email_addresses":[{"id":"ac863d99-db4c-4a70-a9f2-0bfb9cc4713e","value":"john.doe@gmail.com","primary":true}],"urls":{"meeting":"https://meet.example.com/john.doe"},"social":{"instagram":"https://instagram.com/john"},"location":{"country":"IN","state":"Tamil Nadu","city":"Chennai","address":"21 street"},"custom_fields":{"DOB":"14/08/1999"}}},"key":"updated","summary":"Successfully updated contact","id":"paths/~1customers~1{id}/put/responses/200/content/application~1json/examples/updated"},"paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/validationFailed":{"value":{"errors":[{"code":"parameter_invalid","message":"email_addresses: must be a valid email address"},{"code":"parameter_invalid","message":"phone_numbers: must be a valid phone number"}]},"key":"validationFailed","summary":"Validation errors with invalid email and phone","id":"paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/validationFailed"},"paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/alreadyDeleted":{"value":{"errors":[{"code":"resource_conflict","message":"The contact has already been deleted"}]},"key":"alreadyDeleted","summary":"Contact has already been deleted","id":"paths/~1customers~1{id}/put/responses/400/content/application~1json/examples/alreadyDeleted"},"paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1customers~1{id}/put/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1customers~1{id}/put/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"The contact does not belong to the specified account"}]},"key":"forbidden","summary":"Contact does not belong to the caller's account","id":"paths/~1customers~1{id}/put/responses/403/content/application~1json/examples/forbidden"},"paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/unknownId"},"paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1customers~1{id}/put/responses/404/content/application~1json/examples/notFound"},"paths/~1customers~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1customers~1{id}/put/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1customers~1{id}/put/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1customers~1{id}/put/responses/500/content/application~1json/examples/internalError"},"paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1customers~1{id}/delete/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1customers~1{id}/delete/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"Cannot delete internal contacts"}]},"key":"forbidden","summary":"Cannot delete an internal contact","id":"paths/~1customers~1{id}/delete/responses/403/content/application~1json/examples/forbidden"},"paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/unknownId":{"value":{"errors":[{"code":"resource_not_found","message":"The requested ID is not recognized. Please ensure that you entered a valid ID and try again."}]},"key":"unknownId","summary":"The id does not match any resource","id":"paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/unknownId"},"paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/notFound":{"value":{"errors":[{"code":"resource_not_found","message":"The requested resource was not found. Please ensure that you entered a valid resource and try again."}]},"key":"notFound","summary":"Resource not found","id":"paths/~1customers~1{id}/delete/responses/404/content/application~1json/examples/notFound"},"paths/~1customers~1{id}/delete/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1customers~1{id}/delete/responses/500/content/application~1json/examples/internalError"},"paths/~1customers~1bulk/post/responses/200/content/application~1json/examples/mixedResults":{"value":{"data":[{"index":0,"status":201,"data":{"id":"66555f92-a544-46e4-a02b-c2a267fde4ed","first_name":"John","last_name":"Doe","phone_numbers":[{"id":"96003013-e828-432c-a10e-397956995f2d","value":"+918833993399","primary":true}],"email_addresses":[{"id":"be25904f-9719-4a6a-a414-7aa69e480d73","value":"john.doe@gmail.com","primary":true}],"location":{"country":"IN","state":"Tamil Nadu","city":"Chennai","address":"21 street"},"custom_fields":{"DOB":"14/08/1999"}}},{"index":1,"status":400,"error":{"code":"parameter_invalid","message":"email_addresses: must be a valid email address"}}]},"key":"mixedResults","summary":"Bulk operation with one success and one failure","id":"paths/~1customers~1bulk/post/responses/200/content/application~1json/examples/mixedResults"},"paths/~1customers~1bulk/post/responses/400/content/application~1json/examples/emptyRequest":{"value":{"errors":[{"code":"parameter_not_found","message":"Request body must contain at least one contact"}]},"key":"emptyRequest","summary":"Empty request body","id":"paths/~1customers~1bulk/post/responses/400/content/application~1json/examples/emptyRequest"},"paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/missingAuthorization":{"value":{"errors":[{"code":"missing_authorization","message":"Authorization header missing"}]},"key":"missingAuthorization","summary":"No Authorization header present","id":"paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/missingAuthorization"},"paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/tokenExpired":{"value":{"errors":[{"code":"token_expired","message":"Your access token has expired. Please obtain a new token to proceed."}]},"key":"tokenExpired","summary":"Bearer token has expired","id":"paths/~1customers~1bulk/post/responses/401/content/application~1json/examples/tokenExpired"},"paths/~1customers~1bulk/post/responses/403/content/application~1json/examples/forbidden":{"value":{"errors":[{"code":"action_forbidden","message":"Cannot create a contact under an internal account"}]},"key":"forbidden","summary":"Cannot create a contact under an internal account","id":"paths/~1customers~1bulk/post/responses/403/content/application~1json/examples/forbidden"},"paths/~1customers~1bulk/post/responses/413/content/application~1json/examples/payloadTooLarge":{"value":{"errors":[{"code":"payload_too_large","message":"'title' must be at most 255 characters"}]},"key":"payloadTooLarge","summary":"Request body too large","id":"paths/~1customers~1bulk/post/responses/413/content/application~1json/examples/payloadTooLarge"},"paths/~1customers~1bulk/post/responses/500/content/application~1json/examples/internalError":{"value":{"errors":[{"code":"server_error","message":"Something went wrong. Please try again later."}]},"key":"internalError","summary":"Unexpected server error","id":"paths/~1customers~1bulk/post/responses/500/content/application~1json/examples/internalError"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authenticate with a bearer token. Send it in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"header using the format: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer {your_token}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}},"specVersion":"3.0.3","servers":[{"url":"https://developer.setmore.com/api/v2","description":"Production server"}],"specType":"openapi"},"options":{"hideHostname":true,"hideDownloadButtons":true,"schemasExpansionLevel":"all","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/index.json?download"},{"url":"/_bundle/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false,"asyncapi":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Setmore API","description":"# Getting Started\n\nSetmore is an appointment scheduling platform that lets you book customer appointments, choose from available services, and manage appointments across multiple staff calendars under one account. This API provides the Setmore functions you need to build tools and integrations, from creating bookings and fetching available slots to managing services, categories, working hours, and staff and customer contacts.\n\n### **Request access**\n\nTo request access to the API, first make sure you've already signed up for a Setmore Pro account. Then send an email to api@setmore.com and include the following information:\n- Your Name\n- Email address that's registered to your **Setmore account**\n- A brief description of what you'd like to use the API for\n\n#### **What you can build**\n\nThe Setmore API enables you to build custom booking flows, retrieve calendar schedules, and manage customer and staff contacts. With this API, your integration can:\n\n*   **Manage Bookings:** Create, update, fetch, and delete appointments, group class sessions, and events, and add or remove customers on a class session.\n*   **Retrieve Availability:** Query bookable time slots for a staff member and service, check seat availability for upcoming class sessions, and read staff working hours.\n*   **Synchronize Services & Categories:** Create, update, and list services and categories, and assign staff members to services.\n*   **Manage Contacts:** Read staff contacts, and create, update, delete, and bulk-import customer contacts.\n\n#### **Can I sell my integration?**\n\nCurrently, no. We do not have a marketplace to sell or share integrations at this time.\n\n#### **Need help?**\n\nDeveloper & Setmore API Support: Send an email to api@setmore.com.\n\nGeneral Inquiries: Reach out to us at help@setmore.com.\n\n> **Upgrading from v1?** See the [Changelog](/changelog) for what changed in v2 and how to migrate.\n\n## Response envelope\n\nAll responses share one envelope:\n- Success (single resource): `{ \"data\": { ... } }`\n- Success (list): `{ \"data\": [ ... ], \"cursor\": \"...\" }`. `cursor` is\n  omitted when there is no next page.\n- Error (any non-2xx): `{ \"errors\": [ { \"code\": \"...\", \"message\": \"...\" } ] }`.\n  This is always an array, even for a single error, e.g.:\n  ```json\n  {\n    \"errors\": [\n      { \"code\": \"resource_not_found\", \"message\": \"The requested resource does not exist.\" }\n    ]\n  }\n  ```\n\n## Error codes\n\n| Code | Message |\n|---|---|\n| `server_error` | Generic server error. |\n| `client_error` | Generic client error. |\n| `resource_not_found` | The requested resource does not exist. |\n| `token_expired` | The bearer token has expired. |\n| `missing_authorization` | No `Authorization: Bearer` credentials were found on the request. |\n| `unsupported` | The operation is not supported. |\n| `parameter_not_found` | A required parameter was not supplied. |\n| `parameter_invalid` | A parameter's value is invalid. |\n| `action_forbidden` | The action is not authorized for this merchant. |\n| `out_of_range` | A range or count is outside what is allowed (e.g. a slots date range over 7 days, or a booking's `consumer_ids` count). |\n| `resource_conflict` | The request conflicts with the current state of the resource. |\n| `payload_too_large` | A value exceeded the allowed size limit. |\n\n## Time standards\n\nEvery date and time sent to or returned by the API is an\n**[RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)** `date-time`:\n`YYYY-MM-DDThh:mm:ss` followed by an **offset**, which is either `Z` (UTC)\nor a numeric offset such as `+08:00` or `-05:00`.\n\n- **The offset is required.** A time without one is rejected, and fractions\n  of a second are not supported, so send whole seconds.\n- **An offset is not a time zone.** `2026-11-19T00:30:00Z` and\n  `2026-11-19T08:30:00+08:00` are the same moment. Read the offset in a\n  value rather than assuming it is UTC.\n- **Requests** accept `Z` or any numeric offset.\n- **Responses** differ by endpoint, so check the field:\n\n  | Where | Offset returned | Example |\n  |---|---|---|\n  | Bookings and events (`start_at`, `end_at`, `created_at`) | UTC, `Z`. A time sent with an offset comes back as the same moment in UTC. | `2026-11-19T00:30:00Z` |\n  | Available slots (`GET /slots`) | The offset of the requested `timezone`: `+08:00` for `Asia/Singapore`, and `Z` or another offset for other zones. It changes with daylight saving time. | `2026-11-19T08:30:00+08:00` |\n  | Class sessions (`GET /slots/class/{class-key}`) | UTC, `Z`. The requested `timezone` only decides which day a session is listed under. | `2026-01-20T09:00:00Z` |\n\n## Rate limiting\n\nTo ensure high availability and consistent performance, the Setmore API\nis subject to rate limiting. Usage is monitored continuously. While\nstandard traffic limits apply, Setmore reserves the right to dynamically\nadjust or restrict request thresholds per minute based on system health\nand client consumption patterns. If your application exceeds these\nthresholds, the API returns an HTTP `429 Too Many Requests` response.\n\n## Authentication\n\nEvery request must be authenticated with an access token, sent as a bearer\ntoken. When your access request is approved, the Setmore team provisions a\npermanent refresh token and sends it to you by email. Use the refresh token\nto generate access tokens with the token endpoint below.\n\nKeep your refresh token secret. Store it securely on your server and never\nexpose it in client side code.\n\n### 1. Exchange your refresh token\n\nSend a `GET` request to exchange your refresh token for an access token:\n\n```\nGET https://developer.setmore.com/api/v2/o/oauth2/token?refreshToken={your_refresh_token}\n```\n\n### 2. Read the token response\n\nA successful exchange returns the access token and its details:\n\n```json\n{\n  \"response\": true,\n  \"data\": {\n    \"token\": {\n      \"access_token\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n      \"token_type\": \"BEARER\",\n      \"expires_in\": 604799,\n      \"user_id\": \"XXXXXXXXXX-XXXXXXXXXX-XXXXXXXXXX\"\n    }\n  }\n}\n```\n\n| Field | Description |\n|---|---|\n| `access_token` | The bearer token to send with your API requests. |\n| `token_type` | Always `BEARER`. |\n| `expires_in` | How long the access token is valid, in seconds. |\n| `user_id` | The id of the account the token belongs to. |\n\n### 3. Send the access token with your requests\n\nAdd the access token to the `Authorization` header of every request:\n\n```\nAuthorization: Bearer {access_token}\n```\n\n### Token lifespan\n\nAccess tokens are short lived and expire after the number of seconds given\nin `expires_in`. Track the expiry time in your integration and call the token\nendpoint again to get a new access token before the current one expires.\nA request made with an expired token fails with the `token_expired` error\ncode.\n"}},"baseSlug":"/","routesMapping":{}}