Changelog

Each entry is derived from the diff between two published contracts, so a line here is true by construction: a removed operation, a newly required field or a changed scope is listed as breaking and forces a major version of the SDK; an added operation is a minor; prose is a patch. The entries are proposed by the docs bot on a docs/auto/<date> branch and merged by a person.

2026-09-23

The reviewed contract was released as TypeScript and Python SDK 4.0.0 on September 23 from tag sdk-v4.0.0. See the SDK migration guide.

Minimum SDK bump since sdk-v3.0.0: major. This update lists changes since the previous documentation snapshot.

Descriptions drafted for review

• connectorRuntimeGet
• connectorRuntimePut
• hubBleAttendedCover
• hubBleAttendedCoverResult
• hubBleCalibration
• hubBleCalibrationBootstrap
• hubBleCalibrationResult
• hubBleCommission
• hubBleHubs
• hubBleScan
• hubBleStart
• hubBleStop
• hubMatterBootstrap
• hubMatterCancel
• hubMatterDevice
• hubMatterGet
• hubMatterHubs
• hubMatterJobs
• hubMatterRefresh
• hubMatterRemovalGet
• hubMatterRemovalLatest
• hubMatterRemovalStart
• hubMatterStart
• outboxTarget
• zigbeeRecoveryGet
• zigbeeRecoveryImpact
• zigbeeRecoveryStart

2026-09-14

Minimum SDK bump since sdk-v2.3.0: minor. This update lists changes since the previous documentation snapshot.

Changed

• POST /v1/ai/chat: response shape changed
• GET /v1/catalogue/definitions: response shape changed
• GET /v1/catalogue/definitions/{slug}: response shape changed
• GET /v1/integrations/catalogue: response shape changed
• POST /v1/integrations/{integrationId}/discover: request shape changed; response shape changed
• POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
• GET /v1/developers/admin/submissions/{versionId}: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
• GET /v1/developers/admin/submissions: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
• POST /v1/properties/{propertyId}/routines: request shape changed; response shape changed
• GET /v1/properties/{propertyId}/routines/hub: response shape changed
• GET /v1/properties/{propertyId}/routines: response shape changed
• GET /v1/properties/{propertyId}/routines/local: response shape changed
• POST /v1/integrations/{integrationId}/household: response shape changed
• POST /v1/developers/submissions: request shape changed; response shape changed
• GET /v1/developers/submissions/{versionId}: response shape changed
• GET /v1/developers/submissions: response shape changed
• PATCH /v1/developers/submissions/{versionId}: request shape changed; response shape changed

Prose

• POST /v1/integrations/{integrationId}/endpoints: description changed

2026-09-11

HTTP classifier minimum since sdk-v2.3.0: minor. SDK tagging and registry publication remain HELD by the package compatibility review. The operator result uses the existing conservative major/no-tag path; this is not a breaking HTTP-contract claim or a new SDK release. This update lists changes since the previous documentation snapshot.

Added

• POST /v1/auth/home-enrollments/accept: operation added
• POST /v1/auth/home-enrollments: operation added
• POST /v1/auth/home-enrollments/preview: operation added
• POST /v1/auth/partners/setup/complete: operation added
• POST /v1/auth/partners/logout: operation added
• GET /v1/auth/partners/me: operation added
• POST /v1/auth/partners/refresh: operation added
• POST /v1/auth/partners/password-reset: operation added
• POST /v1/auth/partners/password-reset/complete: operation added
• POST /v1/auth/partners/setup: operation added
• POST /v1/auth/partners/login: operation added

Update 2

The automated classifier suggested a minimum minor bump since sdk-v2.3.0. The new nativeApp response value can require updates in consumers of the old enum; SDK publication remains held for explicit compatibility review. See the snapshot review. This update lists changes since the previous documentation snapshot.

Added

• GET /v1/properties/{propertyId}/televisions: operation added
• POST /v1/properties/{propertyId}/televisions/present: operation added
• POST /v1/properties/{propertyId}/televisions/{televisionId}/controller/pairings: operation added
• POST /v1/properties/{propertyId}/televisions/{televisionId}/controller/discover: operation added
• POST /v1/properties/{propertyId}/televisions/{televisionId}/controller/pairings/finish: operation added
• DELETE /v1/properties/{propertyId}/televisions/{televisionId}/controller: operation added
• GET /v1/properties/{propertyId}/televisions/{televisionId}/controller: operation added

Changed

• GET /v1/catalogue/definitions: response shape changed
• GET /v1/catalogue/definitions/{slug}: response shape changed
• GET /v1/integrations/catalogue: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
• GET /v1/developers/admin/submissions/{versionId}: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
• GET /v1/developers/admin/submissions: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
• POST /v1/developers/submissions: request shape changed; response shape changed
• GET /v1/developers/submissions/{versionId}: response shape changed
• GET /v1/developers/submissions: response shape changed
• PATCH /v1/developers/submissions/{versionId}: request shape changed; response shape changed

Update 3

Minimum SDK bump since sdk-v2.3.0: minor. This update lists changes since the previous documentation snapshot.

Prose

• POST /v1/devices/{id}/commands: description changed
• POST /v1/endpoints/{endpointId}/commands: description changed

2026-09-10

Music sources

Media and the speaker picker now share a scrolling row of neutral service pills, ordered Sonos, Apple Music, Spotify, Plex when connected. Sonos favourites belong under its account instead of a duplicate pill. Music-options accounts include public kind and catalogue logo metadata, avoiding extra account/catalogue reads.

Console music layout

The dashboard Music tile now opens the speaker stage before choosing a room. Music and speaker pages share a full-width timeline with elapsed and duration together on the right, a larger seek target, and centered playback controls. Room and music choices open sheets; selecting a room alone does not start playback.

Minimum SDK bump since sdk-v2.2.0: minor. This update lists changes since the previous documentation snapshot.

Changed

• GET /v1/notifications/channels: response shape changed
• POST /v1/endpoints/{endpointId}/commands: response shape changed
• GET /v1/endpoints/{endpointId}: response shape changed
• POST /v1/endpoints/{endpointId}/refresh: response shape changed
• PATCH /v1/endpoints/{endpointId}/calls/{callId}: request shape changed
• POST /v1/endpoints/{endpointId}/calls: request shape changed
• GET /v1/notifications: response shape changed
• GET /v1/properties/{propertyId}/overview: response shape changed
• POST /v1/properties/{propertyId}/refresh: response shape changed
• GET /v1/rooms/{roomId}: response shape changed

Prose

• DELETE /v1/endpoints/{endpointId}/calls/{callId}: description changed

Update 2

Minimum SDK bump since sdk-v2.3.0: minor. This update lists changes since the previous documentation snapshot.

Changed

• POST /v1/devices/{id}/commands: request shape changed
• GET /v1/devices/{id}: response shape changed
• GET /v1/devices: response shape changed
• PATCH /v1/devices/{id}/settings: response shape changed
• POST /v1/endpoints/{endpointId}/commands: request shape changed
• GET /v1/integrations/{integrationId}/library: response shape changed
• GET /v1/integrations/{integrationId}/search: response shape changed
• GET /v1/integrations/{integrationId}/tracks: response shape changed

SDK publication review

The HTTP classifier requests a minor bump. SDK tagging is held because generated TypeScript model exports changed. Package compatibility and the publication configuration remain under review. The API deployment and documentation update remain available; this update does not announce an SDK registry release.

Update 3

Minimum SDK bump since sdk-v2.3.0: minor. This update lists changes since the previous documentation snapshot.

Changed

• GET /v1/properties/{propertyId}/routines/music: response shape changed

2026-09-09

SDK bump forced by the contract diff: major.

Breaking

• POST /v1/auth/forgot-password: scope session -> none
• POST /v1/auth/login: scope session -> none
• POST /v1/auth/logout: scope session -> none
• POST /v1/auth/refresh: scope session -> none
• POST /v1/auth/reset-password: scope session -> none
• POST /v1/developers/auth/forgot-password: scope session -> none
• POST /v1/developers/auth/login: scope session -> none
• POST /v1/developers/auth/logout: scope session -> none
• POST /v1/developers/auth/refresh: scope session -> none
• POST /v1/developers/auth/reset-password: scope session -> none
• POST /v1/developers/signup: scope session -> none
• POST /v1/developers/verify: scope session -> none

Added

• POST /v1/developers/oauth/token: operation added
• POST /v1/developers/resend-verification: operation added
• GET /v1/integrations/{integrationId}/search: operation added
• GET /v1/integrations/{integrationId}/tracks: operation added
• GET /v1/properties/{propertyId}/routines/music: operation added
• POST /v1/integrations/providers/sonos/webhook: operation added
• GET /v1/integrations/{integrationId}/households: operation added
• POST /v1/integrations/{integrationId}/household: operation added
• GET /v1/integrations/oauth/start: operation added

Changed

• POST /v1/auth/register: request shape changed
• PATCH /v1/auth/me: request shape changed
• GET /v1/catalogue/definitions: response shape changed
• GET /v1/catalogue/definitions/{slug}: response shape changed
• GET /v1/devices/{id}: response shape changed
• GET /v1/devices: response shape changed
• PATCH /v1/devices/{id}/settings: response shape changed
• POST /v1/endpoints/{endpointId}/commands: response shape changed
• GET /v1/endpoints/{endpointId}: response shape changed
• POST /v1/endpoints/{endpointId}/refresh: response shape changed
• GET /v1/integrations/catalogue: response shape changed
• GET /v1/integrations: response shape changed
• POST /v1/auth/invitations/{token}/accept: request shape changed
• GET /v1/properties/{propertyId}/overview: response shape changed
• POST /v1/properties/{propertyId}/refresh: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
• GET /v1/developers/admin/submissions/{versionId}: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
• GET /v1/developers/admin/submissions: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
• GET /v1/rooms/{roomId}: response shape changed
• POST /v1/properties/{propertyId}/routines: request shape changed; response shape changed
• GET /v1/properties/{propertyId}/routines: response shape changed
• POST /v1/developers/submissions: request shape changed; response shape changed
• GET /v1/developers/submissions/{versionId}: response shape changed
• GET /v1/developers/submissions: response shape changed
• PATCH /v1/developers/submissions/{versionId}: request shape changed; response shape changed

Prose

• POST /v1/developers/keys: description changed
• GET /v1/integrations/{integrationId}/library: description changed

Descriptions drafted for review

• guestsGet
• invitationsList
• invitationsResend
• invitationsRevoke
• sonosHomesHouseholds

Update 2

Minimum SDK bump since sdk-v0.6.0: major. This update lists changes since the previous documentation snapshot.

Changed

• GET /v1/properties/{propertyId}/routines/local: response shape changed

Prose

• GET /v1/tenants/{tenantId}/clients/{clientId}/guests/{reservationKey}: description changed
• GET /v1/integrations/{integrationId}/tracks: description changed
• GET /v1/tenants/{tenantId}/clients/{clientId}/invitations: description changed
• POST /v1/tenants/{tenantId}/clients/{clientId}/invitations/{invitationId}/resend: description changed
• DELETE /v1/tenants/{tenantId}/clients/{clientId}/invitations/{invitationId}: description changed
• GET /v1/integrations/{integrationId}/households: description changed

Update 3

Minimum SDK bump since sdk-v0.6.0: major. This update lists changes since the previous documentation snapshot.

Added

• GET /v1/endpoints/{endpointId}/door-lock: operation added
• GET /v1/endpoints/{endpointId}/calls/{callId}: operation added
• PATCH /v1/endpoints/{endpointId}/door-lock: operation added
• PATCH /v1/endpoints/{endpointId}/calls/{callId}: operation added
• POST /v1/endpoints/{endpointId}/calls: operation added
• DELETE /v1/endpoints/{endpointId}/calls/{callId}: operation added

Changed

• GET /v1/auth/me: response shape changed
• PATCH /v1/auth/me: request shape changed; response shape changed
• GET /v1/catalogue/definitions: response shape changed
• GET /v1/catalogue/definitions/{slug}: response shape changed
• GET /v1/devices/{id}: response shape changed
• GET /v1/devices: response shape changed
• PATCH /v1/devices/{id}/settings: response shape changed
• POST /v1/endpoints/{endpointId}/commands: response shape changed
• GET /v1/endpoints/{endpointId}: response shape changed
• POST /v1/endpoints/{endpointId}/refresh: response shape changed
• PATCH /v1/endpoints/{endpointId}: request shape changed; response shape changed
• GET /v1/integrations/catalogue: response shape changed
• GET /v1/integrations/{integrationId}/endpoints: response shape changed
• POST /v1/integrations/{integrationId}/endpoints: response shape changed
• GET /v1/tenants/{tenantId}/clients/{clientId}/members: response shape changed
• GET /v1/properties/{propertyId}/overview: response shape changed
• POST /v1/properties/{propertyId}/refresh: response shape changed
• POST /v1/devices/register: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
• GET /v1/developers/admin/submissions/{versionId}: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
• GET /v1/developers/admin/submissions: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
• POST /v1/rooms/{roomId}/members: response shape changed
• GET /v1/rooms/{roomId}: response shape changed
• POST /v1/developers/submissions: request shape changed; response shape changed
• GET /v1/developers/submissions/{versionId}: response shape changed
• GET /v1/developers/submissions: response shape changed
• PATCH /v1/developers/submissions/{versionId}: request shape changed; response shape changed
• GET /v1/voice/utterances/{utteranceId}: response shape changed
• GET /v1/voice/turns: response shape changed

Prose

• GET /v1/integrations/{integrationId}/tracks: description changed

Update 4

Minimum SDK bump since sdk-v2.0.0: minor. This update lists changes since the previous documentation snapshot.

Added

• POST /v1/developers/admin/ai/requests/{grantId}/decision: operation added
• GET /v1/developers/admin/ai/requests: operation added
• POST /v1/developers/ai/requests: operation added
• POST /v1/developers/applications/{definitionId}/ai/credentials: operation added
• GET /v1/developers/applications/{definitionId}/ai: operation added
• PATCH /v1/developers/applications/{definitionId}/ai: operation added
• GET /v1/developers/applications/{definitionId}/ai/usage: operation added
• PATCH /v1/tenants/{tenantId}/inference-consent: operation added

Changed

• POST /v1/ai/chat: response shape changed

Update 5

Minimum SDK bump since sdk-v2.1.0: minor. This update lists changes since the previous documentation snapshot.

Added

• POST /v1/developers/home-confirmation/confirm: operation added
• POST /v1/developers/home-confirmation/preview: operation added
• POST /v1/developers/home-confirmation/revoke: operation added
• POST /v1/developers/homes/tests/{testId}/disable: operation added
• POST /v1/developers/homes/tests: operation added
• GET /v1/developers/homes: operation added
• POST /v1/developers/homes/request: operation added
• GET /v1/developers/homes/tests: operation added
• POST /v1/developers/homes/links/{linkId}/unlink: operation added
• GET /v1/developers/admin/access: operation added
• GET /v1/developers/admin/overview: operation added
• PATCH /v1/developers/admin/developers/{developerId}/status: operation added
• POST /v1/developers/admin/submissions/{versionId}/feedback-draft: operation added
• GET /v1/developers/admin/review-emails: operation added
• POST /v1/developers/admin/review-emails/{emailId}/retry: operation added
• POST /v1/developers/submissions/{versionId}/release: operation added

Changed

• POST /v1/developers/admin/ai/requests/{grantId}/decision: request shape changed; response shape changed
• GET /v1/developers/admin/ai/requests: response shape changed
• POST /v1/developers/ai/requests: response shape changed
• GET /v1/developers/applications/{definitionId}/ai: response shape changed
• PATCH /v1/developers/applications/{definitionId}/ai: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
• GET /v1/developers/admin/submissions/{versionId}: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
• GET /v1/developers/admin/submissions: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
• POST /v1/developers/submissions: response shape changed
• GET /v1/developers/submissions/{versionId}: response shape changed
• GET /v1/developers/submissions: response shape changed
• PATCH /v1/developers/submissions/{versionId}: response shape changed

Prose

• POST /v1/developers/keys: description changed
• POST /v1/developers/submissions/{versionId}/submit: description changed

2026-09-08

SDK bump forced by the contract diff: none.

Descriptions drafted for review

• guestsGet
• invitationsList
• invitationsResend
• invitationsRevoke

2026-09-07

SDK bump forced by the contract diff: minor.

Added

• DELETE /v1/auth/me: operation added
• GET /v1/auth/me/export: operation added
• GET /v1/endpoints/{endpointId}/commands: operation added
• GET /v1/endpoints/{endpointId}/reachability: operation added

Changed

• POST /v1/auth/login: request shape changed
• GET /v1/auth/me: response shape changed
• POST /v1/auth/register: request shape changed
• PATCH /v1/auth/me: request shape changed; response shape changed
• GET /v1/properties/{propertyId}/overview: response shape changed
• POST /v1/properties/{propertyId}/refresh: response shape changed
• POST /v1/rooms: response shape changed
• GET /v1/rooms/{roomId}: response shape changed
• GET /v1/rooms: response shape changed
• PATCH /v1/rooms/{roomId}: request shape changed; response shape changed
• POST /v1/properties/{propertyId}/routines: request shape changed; response shape changed
• GET /v1/properties/{propertyId}/routines: response shape changed

2026-09-06

SDK bump forced by the contract diff: minor.

Added

• GET /v1/properties/{propertyId}/routines/hub: operation added
• GET /v1/properties/{propertyId}/routines/local: operation added
• GET /v1/voice/clips/{name}: operation added
• GET /v1/voice/utterances/{utteranceId}/events: operation added
• GET /v1/voice/utterances/{utteranceId}: operation added

Changed

• GET /v1/catalogue/definitions: response shape changed
• GET /v1/catalogue/definitions/{slug}: response shape changed
• GET /v1/notifications/channels: response shape changed
• PATCH /v1/endpoints/{endpointId}: request shape changed
• GET /v1/integrations/catalogue: response shape changed
• POST /v1/notifications/push-tokens: request shape changed
• POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
• GET /v1/developers/admin/submissions/{versionId}: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
• GET /v1/developers/admin/submissions: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
• POST /v1/properties/{propertyId}/routines: response shape changed
• GET /v1/properties/{propertyId}/routines: response shape changed
• POST /v1/developers/submissions: request shape changed; response shape changed
• GET /v1/developers/submissions/{versionId}: response shape changed
• GET /v1/developers/submissions: response shape changed
• PATCH /v1/developers/submissions/{versionId}: request shape changed; response shape changed
• GET /v1/voice/turns: response shape changed

2026-09-05

SDK bump forced by the contract diff: minor.

Added

• PATCH /v1/auth/me: operation added
• GET /v1/endpoints/{endpointId}/snapshot: operation added
• GET /v1/auth/oauth/authorize: operation added
• POST /v1/auth/oauth/consent: operation added
• GET /v1/auth/oauth/request: operation added
• GET /v1/auth/oauth/grants: operation added
• DELETE /v1/auth/oauth/grants/{grantId}: operation added
• POST /v1/auth/oauth/token: operation added
• GET /v1/properties/{propertyId}/dashboard: operation added
• PUT /v1/properties/{propertyId}/dashboard: operation added
• POST /v1/properties/{propertyId}/routines: operation added
• GET /v1/properties/{propertyId}/routines: operation added
• GET /v1/properties/{propertyId}/weather: operation added

Changed

• GET /v1/auth/me: response shape changed
• GET /v1/capabilities: response shape changed
• GET /v1/notifications/channels: response shape changed
• GET /v1/devices/{id}: response shape changed
• GET /v1/devices: response shape changed
• PATCH /v1/devices/{id}/settings: response shape changed
• POST /v1/endpoints/{endpointId}/commands: response shape changed
• GET /v1/endpoints/{endpointId}: response shape changed
• POST /v1/endpoints/{endpointId}/refresh: response shape changed
• GET /v1/integrations/catalogue: response shape changed
• POST /v1/properties: response shape changed
• GET /v1/properties/{propertyId}: response shape changed
• GET /v1/properties: response shape changed
• GET /v1/properties/{propertyId}/overview: response shape changed
• POST /v1/properties/{propertyId}/refresh: response shape changed
• PATCH /v1/properties/{propertyId}: request shape changed; response shape changed
• GET /v1/rooms/{roomId}: response shape changed

Prose

• GET /v1/developers/admin/submissions: description changed
• DELETE /v1/developers/webhooks/{id}: description changed

2026-09-04

SDK bump forced by the contract diff: minor.

Added

• POST /v1/developers/auth/mfa/disable: operation added
• POST /v1/developers/auth/mfa/enable: operation added
• POST /v1/developers/auth/mfa/setup: operation added

Changed

• GET /v1/catalogue/definitions: response shape changed
• GET /v1/catalogue/definitions/{slug}: response shape changed
• POST /v1/developers/auth/login: request shape changed
• GET /v1/developers/admin/developers: response shape changed
• GET /v1/developers/me: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/approve: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/deprecate: response shape changed
• GET /v1/developers/admin/submissions/{versionId}: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/publish: response shape changed
• GET /v1/developers/admin/submissions: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/reject: response shape changed
• POST /v1/developers/admin/submissions/{versionId}/request-changes: response shape changed
• POST /v1/developers/submissions: request shape changed; response shape changed
• GET /v1/developers/submissions/{versionId}: response shape changed
• GET /v1/developers/submissions: response shape changed
• PATCH /v1/developers/submissions/{versionId}: request shape changed; response shape changed

Descriptions drafted for review

• catalogueDefinitions
• catalogueOne
• developerAuthChange
• developerAuthDisableMfa
• developerAuthForgot
• developerAuthLogout
• developerAuthRefresh
• developerAuthReset
• developersAdminList
• developersAdminQuotaDefaults
• developersAdminSetQuota
• developersKeys
• developersMe
• developersQuota
• developersRotate
• developersUsage
• reviewApprove
• reviewDeprecate
• reviewDetail
• reviewReject
• reviewRequestChanges
• reviewVerify
• submissionsGet
• submissionsList
• submissionsUpdate
• webhooksDeliveries
• webhooksEnable
• webhooksList
• webhooksTest

Drafts refused (named something not in the contract)

• reviewQueue: versionId
• webhooksRemove: events