Developers
← All documentationContents ↓

API Changelog

Versioning policy and the change log for the Simply360 public API.

Versioning Policy

The Simply360 API uses URL-based versioning (/v1/). We follow these principles:

  • Additive changes — new fields, endpoints, and enum values — are made without a version bump.
  • Breaking changes — removed fields, changed types, altered behavior — trigger a new API version.
  • Deprecations are announced in this changelog at least 90 days before removal.

Endpoints are classified into access tiers: standard endpoints are available to external integrations (API keys and OAuth), while privileged endpoints are reserved for first-party Simply360 clients. Tier reclassifications are noted below because they change what your credentials can reach.

Developer Tooling Status

The TypeScript SDK (@simply360/sdk) and CLI (@simply360/cli) are in developer preview and not yet published to the public npm registry; publication will be announced here. The hosted MCP Server is live at https://api.simply360.app/v1/mcp.

2026-07-07

  • DataViews — New GET /v1/data-views/{dataViewSimplyId}/share-readiness reports whether a view is ready to share. Admin DataView management endpoints (admin list/detail, field links, public access tokens, internal-name validation) moved to the privileged tier.
  • Simply Spaces — New public booking-link availability endpoints: POST /v1/simply-spaces/booking-links/{bookingLinkSimplyId}/slots and .../slot-grid.
  • Sign-up & MFA — Brand-aware self-serve sign-up (POST /v1/auth/sign-up and POST /v1/auth/sign-up/verify) replaces the earlier Simply Websites–specific sign-up operations. Added POST /v1/users/me/self-serve-teams to provision a self-serve team and POST /v1/users/me/mfa/complete-setup to complete TOTP MFA setup.
  • DataWizards — New GET /v1/data-wizards/{dataWizardSimplyId}/instances (submission instance metadata) and GET /v1/data-wizards/{dataWizardSimplyId}/readiness.
  • Websites — New POST /v1/websites/{websiteSimplyId}/header-footer/publish publishes a website's draft header and footer.

2026-07-06

  • Payment accounts — New endpoint group under /v1/team/payment-accounts: create and list accounts, Stripe Connect authorize/complete, set default, deactivate/reactivate, and deactivation-impact preview.
  • Billing — Team billing self-service under /v1/team/billing-status: invoice summaries, invoice receipt detail plus receipt.pdf download, next-invoice estimate, archive review candidates and archive execution plan (preview and execute), auto-archive policy, and SMS prepaid controls and top-up requests.
  • Website templates — New lifecycle under /v1/website-templates: create, list, get, update, release a version, and create a website from a released template; plus per-website template apply, disconnect, and page detach.
  • Message Studio — Team-saved email layouts: POST/GET /v1/outgoing-messages/saved-layouts.
  • Conversations — New POST /v1/conversations/widgets/{widgetSimplyId}/billing-activation prepares live conversation-widget billing activation.
  • Blueprints — New POST /v1/blueprints/bundles/installations installs a recommended Blueprint bundle into the selected team.
  • Tier changes — Background tasks, create menu, notifications, outgoing-message reads, realtime config, and Ask Simply (team-agent) endpoints moved from privileged to standard.

2026-07-05

  • Website layouts — New layout catalog (GET /v1/website-layouts/catalog) and team-saved website layouts (save, list, get, update, archive under /v1/websites/{websiteSimplyId}/saved-layouts).
  • MCP — The hosted MCP endpoint gained read-only team billing tools: get_team_billing_status, list_team_billing_invoices, get_team_billing_invoice_receipt, and get_team_billing_next_invoice_estimate.

2026-07-04

  • DataRecords — New GET /v1/data-records/{dataRecordSimplyId}/website-pages lists published Dynamic Website pages for a record.
  • Messages — New outgoing-message GET .../send-readiness and POST .../test-send endpoints.

2026-07-03

  • Website Studio — Major API wave: page design read and patch (GET/PATCH /v1/website-pages/{pageSimplyId}/design), page blocks, bounded studio context, publish-readiness checks, website backups (create, list, get, restore), website import (discover, start, review), AI draft endpoints (site-plan drafts, page drafts, block drafts, selected-text rewrite drafts), draft preview sessions, and Access Area root-page creation. Seven earlier AI website-copy and generation endpoints were removed in favor of the draft endpoints.
  • Tier changes — Around fifty website endpoints (websites, pages, comments, versions, experiments, access areas, permissions, blog setup, translation) moved from privileged to standard. Workspace endpoints also moved to standard.
  • API Keys — New PATCH /v1/api-keys/{apiKeySimplyId} for partial key updates.
  • MCP — Website Studio MCP tools are now gated by the TEAM_WEBSITES/TEAM_ADMIN_WEBSITES feature permissions.

2026-07-02

  • Tier changes — Current-user endpoints (/v1/users/me, mobile devices, recent visits, sessions) moved from privileged to standard.

2026-07-01

  • Website Access Areas — New endpoint group: create, list, update, delete Access Areas; resolve the effective inherited Access Area for a page; list and install reusable Access Area templates.
  • Data Filters — /v1/data-filter-definitions (create, list, update, delete) replaces the removed data-filter preset endpoints.
  • DataWizards — Wizard authoring and admin endpoints reclassified to the privileged tier.
  • Simply Spaces — New booking participation-record update endpoint.

2026-06-30

  • Simply Spaces bookings — New booking rails: public booking-link availability, quote, and run endpoints, plus internal source-connection booking availability, quotes, runs, and booking channels (list and provision).
  • Ask Simply — New knowledge-source settings, support-scope settings, support availability, and support-handoff endpoints.
  • MCP — Added read-only Simply Spaces booking-channel parity (list_simply_spaces_booking_channels).

2026-06-29

  • Signing Requests — New API: POST/GET /v1/signing-requests, get by id, resend signer links, and void.
  • Simply Action Credentials — New API: issue, present (including signed hardware readers), update status, register readers, and create credential templates.
  • SimplyTags — New analytics endpoints: GET /v1/action-tags/analytics and per-tag analytics.

2026-06-28

  • Background tasks — Typed output defaults, eligible destination fields, per-record task history, and per-record output downloads replace the removed generated-files endpoints.
  • Commerce — New cart-recovery group under /v1/team/commerce/carts: list, summary, detail, expire, recovery links, and recovery suppression.
  • Ask Simply — New team-agent endpoints: sessions, messages, and proposal approve/reject.
  • Simply Spaces — New mapped snapshot and live-update webhook-subscription endpoints.
  • Tier changes — Data-record admin surfaces (admin list, rich detail pipeline, duplicates, bulk operations, kanban/timeline queries, variants, approvals) reclassified to the privileged tier.

2026-06-25

  • Conversations — New analytics content-gaps listing and a widget simulate endpoint for no-persist admin test messages.

2026-06-24

  • Baseline — Automated tracking of the public OpenAPI surface began with a baseline snapshot of 714 public operations. Changes after this date are recorded as dated entries above.

v1.0.0 — March 2026

Initial public release of the Simply360 API.

Endpoints

  • Data Records — CRUD, search, and batch operations (/v1/data-records)
  • Data Collections — Collection and field schema (/v1/data-collections)
  • Data Views — List, get, execute (/v1/data-views)
  • Data Wizards — List, schema, execution (/v1/data-wizards)
  • Users — Current user, list, get (/v1/users)
  • API Keys — Lifecycle and rotation (/v1/api-keys)
  • Session Tokens — Short-lived scoped tokens (/v1/session-tokens)
  • Messages — Send messages via templates (/v1/messages)
  • Conversations — Threads and messages (/v1/conversations)
  • Automations — Read configurations and execution history (/v1/automations)
  • Files — Metadata, download URLs, and image variants (/v1/files)
  • Tags — SimplyTags and scan history (/v1/action-tags)
  • Webhooks — Subscriptions and delivery logs (/v1/webhooks)
  • Reports — List, get, run (/v1/reports)
  • Audit Log — Data record change history (/v1/audit-log)
  • Constituent Auth — Identity verification flows (/v1/constituent-auth/initiate)
  • App Store — Purchase verification and entitlements (/v1/app-store/entitlements)

Authentication

  • API key authentication (s360_live_*)
  • Session token authentication (s360_sess_*) for short-lived scoped access
  • Cognito JWT authentication for first-party clients (with X-Team-Id header)

Platform Features

  • Per-API-key rate limiting with configurable per-minute quotas
  • Offset-based pagination with sort expressions
  • Field selection via the fields query parameter for efficient queries
  • Resource expansion via the expand query parameter
  • Consistent response envelope: { data, meta } for success, { error, meta } for errors
  • Every response carries a requestId for support correlation
↑