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 surveys field has been added to the Events GraphQL API
- We have added mutation support for Tasks, adding create (Event, Contact, and Opportunity), update, and delete mutations. We have also added eventId, contactId, and opportunityId as filter fields for tasks, as well as adding timeZoneName, showOnCalendar, event, contact, and opportunity as queryable fields on the task entity type
Fixes
- We fixed an issue where the “Opportunity Updated” webhook did not trigger when attributes were updated for the first time
- We fixed an issue where calling the session.addStaff mutation for a private event returned “Permission Denied” even when the user had the correct permissions
- We fixed an issue with the EventMutations.addStaff so it now sets a new administrator as “Primary” if the Event did not already have one set
LMS API Documentation | Deprecation Notices
Fixes
- We have exposed remainingPlaces via the eventField Type in the LMS API
WebLink API Documentation | Deprecation Notices
None
WebLink Widgets Documentation
None