GraphQL API - Documentation | Deprecation Notices
Important - Upcoming API Changes
All fields listed below will no longer be available after 2025-03-03. Please refer to the ‘Replace with’ column for alternatives:
| InputType | Retired Field | Replace with |
| CoursePublicPriceInput | currencyCode | financialUnitId |
| CourseTemplateCreateInput | lifecycle | lifecycleState |
| CourseTemplateUpdateInput | lifecycle | lifecycleState |
| LearningPathLearnerRegistrationInput | currencyCode | financialUnitId |
| PrivateEventDetailsCreateInputType | currencyId | financialUnitId |
| RemoveEventStaffInputType | eventId | N/A. Field not necessary and is ignored |
| EventUpdateInputType | courseCode | code |
| EventUpdateInputType | location | locationId |
| EventUpdateInputType | taxType | taxTypeId |
| EventUpdateInputType | timeZone | timeZoneName |
| EventUpdateInputType | lifecycle | lifecycleState |
| EventRegisterContactsInputType | currencyCode | financialUnitId |
| CreateLmsResourceInputType | instructions | htmlDescription |
| CreateLmsResourceInputType | description | displayName for Content of type Separator, Discussion, Kryterion, and External. Otherwise in favor of htmlDescription. |
| UpdateLmsResourceInputType | instructions | htmlDescription |
| UpdateLmsResourceInputType | description | displayName for Content of type Separator, Discussion, Kryterion, and External. Otherwise in favor of htmlDescription. |
| EventAddPriceInputType | currencyCode | financialUnitId |
| EventAddPriceInputType | tokenTypeId | financialUnitId |
| SessionRemoveStaffInputType | sessionId | N/A. Field not necessary and is ignored |
| WebhookCreateInputType | emailAddress | notificationEmails |
| WebhookUpdateInputType | emailAddress | notificationEmails |
Updates
- The invoices.finalise mutation now requires users to have the “Sales Invoice - Finalize” permission in order to finalize invoices. If the user already had edit permissions for sales invoices, they will automatically have the necessary “Sales Invoice - Finalize” permission, so no changes are needed
- Credly authorization tokens are now automatically rotated every 3 months (180 days) to enhance security. If no badges are issued within 6 months, tokens will require manual rotation to maintain functionality
Fixes
- We have addressed an issue in the PortalMutations.create and PortalMutations.update mutations, where a portal could be created with a suffix containing invalid characters (for instance, “&” or “.”), which could break the URL pattern
LMS API Documentation | Deprecation Notices
Fixes
- The LMS API now correctly returns the list of categories for a Learning Path’s CourseObjective instead of returning null values
WebLink API Documentation | Deprecation Notices
- You can now remove a payment provider using the PortalMutations.removeWebLinkPaymentProvider mutation, enabling greater flexibility in managing payment configurations.
WebLink Widgets Documentation
None