Change Updates

Do not miss any Connect API changes, ever again

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

RSS

Changelog

Last update:
Compare

New Features

Update User Primary Email (PUT /users/{userId}/emails/primary): updates the user's primary email address

1 structure change including:
1 Addition
Added 1
PUT /users/{userId}/emails/primary

Update Student Details (PATCH /students/{userId}/details): Update a student's date of birth or gender

Update User Name (PUT /users/{userId}/name): Update a user's name

Update User Password (PUT /users/{userId}/password): Change a user's password

3 structure changes including:
3 Additions
Added 3
PATCH /students/{userId}/details
PUT /users/{userId}/name
PUT /users/{userId}/password

New Features (Draft)

List Completed Study Sessions (GET /sessions/completed): List and filter user study sessions

Updates

Sync changes from main

5 structure changes including:
2 Additions
3 Modifications
Modified 3 Breaking
GET /smart-ia/cohorts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • tests property Modified
GET /smart-ia/cohorts/{cohortId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cohort property Modified
        • tests property Modified
POST /smart-ia/cohorts
  • Body
  • application/json content type Modified
    • cohort property Modified
      • tests property Modified
        • testId property Modified
          • Property is now required
            Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • cohort property Modified
        • tests property Modified
Added 2
GET /sessions/completed
POST /users/{userId}/enable
4 structure changes including:
4 Modifications
Modified 4
GET /users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • Query
  • name, sort query parameters Added
POST /students
  • Response
  • 201 response Modified
    • application/json content type Modified
      • user property Modified
POST /teachers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • user property Modified
POST /users/search
  • Body
  • application/json content type Modified
    • search property Modified
      • name property Added
    • sort property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
4 structure changes including:
2 Additions
2 Modifications
Modified 2
POST /students
  • Response
  • 201 response Modified
    • application/json content type Modified
      • user property Modified
POST /teachers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • user property Modified
Added 2
GET /users
POST /users/search
3 structure changes including:
1 Addition
2 Modifications
Modified 2 Breaking
POST /students
  • Body
  • application/json content type Modified
    • reEnable property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /teachers
  • Body
  • application/json content type Modified
    • reEnable property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
Added 1
POST /students/{userId}/cohorts