Change Updates

Do not miss any API changes, ever again

Subscribe to the API changelog to be up to date on recent changes.

RSS
API

Changelog

Last update:
Compare
1 structure change including:
1 Modification
Modified 1
DELETE /v1/lives/{liveId}
  • Response
  • 409 response Added
7 structure changes including:
7 Breaking changes
7 Removals
Removed 7 Breaking
GET /v1/integrationSchemas
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/spotMembers/me
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/widget
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/auth/accessToken/email
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/auth/accessToken/sso/jwt
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/auth/accessToken~refresh
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/spotMembers/auth/sso/jwt
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
11 structure changes including:
11 Modifications
Modified 11
GET /v1/channels/{channelId}/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lastActivityAt property Added
GET /v1/forums/{forumId}/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lastActivityAt property Added
GET /v1/groups/{groupId}/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lastActivityAt property Added
GET /v1/reportedResources/{reportedResourceId}/reports
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lastActivityAt property Added
GET /v1/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lastActivityAt property Added
GET /v1/spotMembers/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lastActivityAt property Added
GET /v1/spotMembers/{spotMemberId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lastActivityAt property Added
GET /v1/tags/{tagId}/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lastActivityAt property Added
POST /v1/spotMembers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • lastActivityAt property Added
POST /v1/spotMembers~bulkInvite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created property Modified
        • lastActivityAt property Added
PUT /v1/spotMembers/{spotMemberId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lastActivityAt property Added
6 structure changes including:
1 Addition
5 Modifications
Modified 5
GET /v1/spotMembers
  • Response
  • 401, 403 responses Added
GET /v1/spotMembers/{spotMemberId}
  • Response
  • 400, 401, 403 responses Added
GET /v1/spotMembers/{spotMemberId}/customFormAnswers
  • Response
  • 400, 401, 403 responses Added
POST /v1/spotMembers
  • Response
  • 401, 403 responses Added
PUT /v1/spotMembers/{spotMemberId}
  • Response
  • 401, 403 responses Added
Added 1
GET /v1/spotMembers/me
4 structure changes including:
4 Modifications
Modified 4
POST /v1/channels
  • Body
  • application/json content type Modified
    • readonly property Added
POST /v1/channels~bulkCreate
  • Body
  • application/json content type Modified
    • readonly property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • failed property Modified
        • readonly property Added
POST /v1/forums/{forumId}/topics~bulkCreate
  • Response
  • 201 response Modified
    • application/json content type Modified
      • failed property Modified
        • readonly property Added
PUT /v1/channels/{channelId}
  • Body
  • application/json content type Modified
    • readonly property Added
6 structure changes including:
6 Modifications
Modified 6
GET /v1/channels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • readonly property Added
GET /v1/channels/{channelId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • readonly property Added
POST /v1/channels
  • Response
  • 201 response Modified
    • application/json content type Modified
      • readonly property Added
POST /v1/channels~bulkCreate
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created property Modified
        • readonly property Added
POST /v1/forums/{forumId}/topics~bulkCreate
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created property Modified
        • readonly property Added
PUT /v1/channels/{channelId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • readonly property Added
1 structure change including:
1 Modification
Modified 1 Breaking
GET /v1/activities~export
  • Query
  • limit query parameter Modified
    • Type went from integer to string
      Breaking
1 structure change including:
1 Addition
Added 1
GET /v1/activities~export
10 structure changes including:
10 Modifications
Modified 10
GET /v1/channels/{channelId}/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lang, updatedAt properties Added
GET /v1/forums/{forumId}/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lang, updatedAt properties Added
GET /v1/groups/{groupId}/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lang, updatedAt properties Added
GET /v1/reportedResources/{reportedResourceId}/reports
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lang, updatedAt properties Added
GET /v1/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lang, updatedAt properties Added
  • Query
  • updatedAt[before], updatedAt[after] query parameters Added
GET /v1/spotMembers/{spotMemberId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lang, updatedAt properties Added
GET /v1/tags/{tagId}/spotMembers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • lang, updatedAt properties Added
POST /v1/spotMembers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • lang, updatedAt properties Added
POST /v1/spotMembers~bulkInvite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created property Modified
        • lang, updatedAt properties Added
PUT /v1/spotMembers/{spotMemberId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lang, updatedAt properties Added
6 structure changes including:
6 Additions
Added 6
GET /v1/integrationSchemas
GET /v1/widget
POST /v1/auth/accessToken/email
POST /v1/auth/accessToken/sso/jwt
POST /v1/auth/accessToken~refresh
POST /v1/spotMembers/auth/sso/jwt
3 structure changes including:
1 Addition
2 Modifications
Modified 2
GET /v1/courses
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • moduleName property Added
  • Query
  • moduleName[eq], moduleName[contains] query parameters Added
GET /v1/lives/{liveId}/groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • emailNotificationEnabled property Added
Added 1
GET /v1/courses/{courseId}/groups
1 structure change including:
1 Modification
Modified 1 Breaking
PUT /v1/spotMembers/{spotMemberId}
  • Body
  • application/json content type Modified
    • avatarUrl property Modified
      • Type went from object | null to string | null
        Breaking
6 structure changes including:
2 Additions
4 Modifications
Modified 4
GET /v1/forums/{forumId}/topics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • closedAt property Added
GET /v1/forums/{forumId}/topics/{topicId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • closedAt property Added
POST /v1/forums/{forumId}/topics
  • Response
  • 201 response Modified
    • application/json content type Modified
      • closedAt property Added
PUT /v1/forums/{forumId}/topics/{topicId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • closedAt property Added
Added 2
GET /v1/courses/{courseId}/participants/{courseParticipantId}/stepCompletions
GET /v1/courses/{courseId}/participants/{courseParticipantId}/stepCompletions/{stepCompletionId}
2 structure changes including:
2 Additions
Added 2
GET /v1/courses/{courseId}/participants/{courseParticipantId}
GET /v1/courses/{courseId}/steps
7 structure changes including:
7 Modifications
Modified 7 Breaking
GET /v1/channels/{channelId}/groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • icon property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • icon property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/groups/{groupId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • icon property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /v1/lives/{liveId}/groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • icon property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST /v1/groups
  • Response
  • 201 response Modified
    • application/json content type Modified
      • icon property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/groups~bulkCreate
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created property Modified
        • icon property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
PUT /v1/groups/{groupId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • icon property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
8 structure changes including:
3 Additions
5 Modifications
Modified 5
GET /v1/lives
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • builtInConfig property Modified
GET /v1/lives/{liveId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • builtInConfig property Modified
        • enableBreakoutRooms, enableRaiseHand, enablePictureInPicture properties Added
GET /v1/search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • SearchableForumApiResponse, SearchableCollectionApiResponse, SearchableLiveApiResponse, SearchableChannelApiResponse, SearchableCourseApiResponse alternatives Modified
  • Query
  • groupId query parameter Added
POST /v1/lives
  • Body
  • application/json content type Modified
    • enableBreakoutRooms property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • builtInConfig property Modified
        • enableBreakoutRooms, enableRaiseHand, enablePictureInPicture properties Added
PUT /v1/lives/{liveId}
  • Body
  • application/json content type Modified
    • enableBreakoutRooms property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • builtInConfig property Modified
        • enableBreakoutRooms, enableRaiseHand, enablePictureInPicture properties Added
Added 3
GET /v1/spotMembers/{spotMemberId}/customPropertiesValues
POST /v1/spotMembers/{spotMemberId}/customPropertiesValues~bulkUpsert
PUT /v1/spotMembers/{spotMemberId}/customPropertiesValues/{customPropertySlug}