We recently introduced an upgraded GraphQL parser that enforced GraphQL specification query validations that were previously ignored. The API schema did not change.
This was done to provide a more reliable and consistent API experience while also simplifying integrations with other GraphQL-compliant tools.
This upgrade caused queries that previously passed validation in 2024-07 to fail in 2024-10.
Solution
To avoid any breaking changes in version 2024-10, we've made the new parser backward compatible. This means that you can request 2024-10 in the API-Versionheader to continue using the query successfully.
From 2025-01 onwards, some validation rules will be introduced as breaking changes. You will then need to adjust your queries according to the documented schema. Queries that don't meet these standards may fail.
Impact
This fix impacts a variety of queries, including those that use a line break inside of a string or send null in a non-nullable field. If you switch to 2024-10 and encounter any unannounced breaking changes, please open a support ticket to report it to the team.
Test your queries
If you want to test your query, we recommend using the API playground. Before running the query, if any of it is not valid, you should see a syntax error in red on the left side. In versions 2024-10 and earlier, the query will still run successfully despite the error.
Examples
Line breaks
For scenarios that do not involve line breaks directly within string values, 2024-10 and earlier would accept the input in the example below.
Big update for version 2025-01 and beyond: errors now have a consistent format compliant with the GraphQL specification!
This may be a breaking change for your application. Use version 2024-10 until you migrate your applications to handle the new error structure.
Errors will be returned in the following format:
HTTP status: Response will be 200 – OK for application-level errors. Other statuses will be returned for transport-layer errors, such as 429 - Too many requests or 400 - Bad request
JSON response: Body will contain an errors array with further details about each error
Partial data: Your query may return partial data and throw errors. In that case, you will receive both the data and errors objects. If a field throws an error, it will return null.
We released a hotfix in 2024-10 to the pin_to_top and unpin_from_top mutations. The item_id argument on both mutations has changed from type Int to ID, and it is no longer required.
Arguments
Argument
Description
id ID!
The unique identifier of the update to pin or unpin.
The platform API will support the Emails & Activities (E&A) app in API versions 2024-10 and later. We added the following queries to read, create, and delete custom activities in the E&A app:
We added the team_owners and team_subscribersfields to boards queries in API versions 2024-10 and later. These fields return the teams that are either subscribed to or owners of the board.
On Tuesday, September 10th, at 7:30 AM EST, we will conduct 60 minutes of planned maintenance on the following low-utilization endpoints in the RC version (i.e., 2024-10) ONLY: