> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.cloudbridal.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# API Changelog

# CloudBridal API Changelog

Changes to the CloudBridal API, newest first. The endpoint reference, linked from the API Access
screen in CloudBridal, holds the request and response schemas, permissions, limits and examples for
each operation; this page records what changed and when.

Within v1 the contract is additive: new fields and endpoints may be added, and existing fields and
endpoints are not renamed, removed or retyped. An integration written against v1 keeps working.

## v1 — September 2026

The first release of the CloudBridal API.

### Capabilities

* **Store information:** Read the store's identity, time zone, currency and customer types.
* **Appointments:** Read appointment types and availability, book and reschedule appointments,
  cancel bookings, and add customers to the waitlist.
* **Customers and events:** Create and update customer records, check for duplicates, manage
  events and their participants, and send customer messages or portal invitations with consent
  checks.
* **Inventory:** Read products, variants, retail prices, stock, images, vendors and tags.
* **Orders and payments:** Read order tickets, balances, payments and refunds. Money and stock
  are read-only; the API does not take payments, issue refunds or adjust inventory.
* **Change notifications:** Subscribe to signed webhooks for appointment, customer, order,
  payment and inventory changes, with delivery history and automatic retries. Incremental
  polling is also available for keeping records in sync.
* **API keys and sandbox:** Use permission-scoped server-side keys and a free practice store to
  build and test integrations. Access to live store data requires the API Access add-on.

### Integration foundations

v1 includes opaque record identifiers, paginated lists, structured error responses with request
IDs, rate-limit headers, partial updates, and idempotency keys for retrying POST requests.