Do not miss any API changes, ever again

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

RSS
API

about 1 hour ago

main
v1
Compare

API structure has changed

Next change
12 structure changes including:
1 Addition
11 Modifications
Modified 11 Breaking
GET /v1/courses/{courseId}/participants/{courseParticipantId}/stepCompletions
  • Query
  • contentType query parameter Modified
    • solution[in], solution[eq] query parameters Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • contentType[in], contentType[eq] query parameters Added
GET /v1/courses/{courseId}/steps
  • Query
  • contentType query parameter Modified
    • solution[in], solution[eq] query parameters Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • contentType[in], contentType[eq] query parameters Added
GET /v1/reportedResources/{reportedResourceId}/context
  • Response
  • 200 response Modified
    • application/json content type Modified
      • context property Modified
        • ChannelMessageReportedResourceApiResponse, DiscussionMessageReportedResourceApiResponse, LiveMessageReportedResourceApiResponse, TopicAnswerReportedResourceApiResponse, TopicReportedResourceApiResponse alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ChannelMessage, DiscussionMessage, LiveMessage, TopicAnswer, Topic alternatives Added
GET /v1/reportedResources/{reportedResourceId}/reports
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • spotId, userId, email, title, lang, role, customRoleId, firstname, lastname, avatarUrl, warnings, embedBaseUrls, updatedAt, lastActivityAt properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • content, reason, reporter, internalNote, createdAt properties Added
GET /v1/reportedResources/{reportedResourceId}/reports/{reportId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • ThreadMessageReportedContentApiResponse, TopicReportedContentApiResponse alternatives Modified
POST /v1/channels/{channelId}/groups~bulkAdd
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
POST /v1/channels/{channelId}/groups~bulkRemove
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
POST /v1/channels/{channelId}/spotMembers~bulkRemove
  • Response
  • 200 response Modified
    • application/json content type Modified
      • removedSpotMemberIds, failedSpotMemberIds properties Added
POST /v1/courses/{courseId}/groups~bulkAdd
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200, 404 responses Added
POST /v1/courses/{courseId}/groups~bulkRemove
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200, 404 responses Added
POST /v1/reportedResources~bulkValidate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failedReportedResourceIds property Added
Added 1
GET /v1/courses/{courseId}