Changelog
Last updated

Changelog

Here is the log of changes to the API.

2025-05-01

FIX:

Corrected the documentation for the Make Alternate Email Primary endpoint POST /users/{userId}/alternateemails/{alternatEmailId}/makeprimary to state that it is only for Enterprise plans with the feature activated by Support.

2025-04-30

ADDITION:

We added the ability to remove users from User Subscription Model (USM) plans via the DELETE /users/{userId} endpoint.

2025-04-24

ADDITION:

For Event Reporting, we now include the email address of the user responsible for the event. The emailAddress property is in each event's additionalDetails property.

For example,

{
    "eventId": "2.1.saN0P9Eg7CAwauk5yRTz1jS5J6q7Fj9OzJJkJJvgtUI",
    "objectType": "SHEET",
    "action": "LOAD",
    "objectId": 2242242917230468,
    "eventTimestamp": "2025-02-04T22:07:39Z",
    "userId": 4159154089682820,
    "requestUserId": 4159154089682820,
    "source": "API_INTEGRATED_APP",
    "additionalDetails": {
        "emailAddress": "john.doe@company.com"
    }
}

NOTE: For event types that already have an additionalDetails.emailAddress property, we preserved their existing email address behavior.

Please see the Events section for event endpoints and the Event Reporting Reference for event types.

2025-04-22

DEPRECATION:

To improve performance of the GET /users/* endpoints, we deprecated the sheetCount response attribute for the following endpoints:

As early as 05-12-2025, the current sheetCount behavior will be discontinued, and sheetCount will instead hold the value -1 and be included only if the user's status is ACTIVE.

2025-04-21

FIX:

We fixed the transferTo query parameter type of DELETE /users/{userId} from number to integer, with format: int64.

2025-04-16

FIX:

We fixed the DELETE /users/{userId} specification to reflect that the endpoint takes the following parameters as query parameters--not body parameters:

  • removeFromSharing
  • transferSheets
  • transferTo

2025-04-07

FIX:

We removed the Search result item schema's proofUrl property and mention a proof URL as a possible contextData property item. The Search endpoint responses never included a proofUrl property--a proof URL was always a possible string value in the context data.

2025-04-01

IMPROVEMENT:

With the User Subscription Model (USM), you can now deactivate and reactivate users with non-ISP domain primary email addresses belonging to your plan.

Regarding user reactivation, you can now reactivate a user to your plan if the user has been deactivated less than 30 days. The previous threshold was 7 days.

2025-03-31

REMOVAL:

We removed the following properties from GET /sights/{sightId} response.

  • favorite has been deprecated since July 2024.
  • workspace.accessLevel has never been included in the response.
  • workspace.permalink has never been included in the response.

2025-03-25

DEPRECATION:

We deprecated the "Sheets" folder and are replacing it with Workspaces for a more streamlined experience.

We're providing access to the following API endpoints associated with the "Sheets" folder until June.

As part of this deprecation, we deprecated the home destinationType enum in folder and sheets endpoints.

Learn how to update your code to these changes at Migrate from using the Sheets folder.

2025-03-14

FIX:

We updated the Event schema documentation to provide more accurate examples and comprehensive information:

  • Updated the eventId example to match the actual format used in production
  • Expanded the objectType enum to include all possible resource types
  • Fixed the property name from eventTimeStamp to eventTimestamp
  • Updated the source field description and added the complete list of possible values

2025-03-11

FIX:

We fixed the Criteria schema's operator property to include the enum value IS_ONE_OF. The value has been part of the schema implementation and is listed in the example but missing from the property documentation.

2025-03-07

FIX:

We fixed the Assume-User header description. The header allows System Administrators (admins) to impersonate or act on behalf of any user (including other admins) in their plan to make API calls. For details, see User Impersonation.

2025-03-04

ADDITION:

We added the POST filteredEvents endpoint. This endpoint allows non-admin users to retrieve events for sheets and workspaces that they have access to.

2025-03-03

DEPRECATION REVERT:

We reverted deprecation notices for the following endpoint methods:

See 2025-02-01 for the original change.

ADDITION REVERT:

We removed the 'lastKey' query parameter from the GET /workspaces endpoint method.

See 2025-02-18 for the original change.

2025-02-18

ADDITION:

We added the lastKey query parameter and response property for the GET /workspaces endpoint method. This is the new and recommended way to get paginated workspace results. The pageSize query parameter is used in conjunction with lastKey--the page and includeAll query parameters remain deprecated and will be removed.

2025-02-12

REMOVAL:

We removed the permalink option from the include query parameter for the following endpoint methods because the option has never been supported:

2025-02-10

FIX:

We corrected response schemas for the following endpoint methods:

2025-02-03

DEPRECATION:

We deprecated the distributionLink and sheetVersion options for the include query parameter on the following endpoint methods:

The corresponding response properties will soon stop providing meaningful values.

DEPRECATION:

We deprecated the loadAll query parameter on the GET /folders/{folderId} endpoint method, and we will eventually remove it. To replace the loadAll query parameter, use calls to GET /folders/{folderId} to build out workspace structures.

FIX:

Regarding the ownerInfo option for the include query parameter, we clarified which user is returned when no user is an Owner of the asset.

2025-02-01

DEPRECATION:

We deprecated the includeAll and page params for the following endpoint methods:

We deprecated the following response properties because they are irrelevant to the new pagination system.

  • pageNumber
  • totalCount
  • totalPages

2025-01-22

IMPROVEMENT:

We now automatically deactivate Webhooks on sheets exceeding any scale limits.

Scale limits:

  • 20,000 rows
  • 400 columns
  • 500,000 cells

Related resources:

To keep webhooks enabled on a sheet, stay below the limits mentioned above.

As a sheet Owner, you can re-enable webhooks on a sheet by following these steps:

  1. Reduce the sheet size to within the limits mentioned above.
  2. Execute the PUT /webhooks/{webhookId} method with the enabled body attribute set to true.

Related resources:

2024-10-14

IMPROVEMENT:

For Smartsheet US and Smartsheet Regions Europe, we introduced a one-minute debounce to optimize event trigger handling in the Webhooks event callback API. It reduces traffic and prevents workflows from acting on incomplete or transitional data.

2024-10-09

FIX:

We updated the WebContentWidgetContent.type enum, from WEBCONTENT to WidgetWebContent. The former enum WEBCONTENT was incorrect.

Previous page
Next page