Workiva Connector: API version selection for spreadsheet commands

Workiva Connector spreadsheet commands use the Workiva Platform API. The current version is 2022-01-01, but this will be retired. To keep your chains working, we’re moving every Workiva Connector command to version 2026-01-01.

Most Workiva connector commands move to 2026-01-01 automatically on 30 November 2026, and you won’t need to edit your chains. Inputs and outputs do not change.

Spreadsheet commands

With the introduction of API version 2026-01-01, the spreadsheet commands in the Workiva connector now have an API Version field, requiring you to choose either 2022 or 2026. The default is 2022, and a command with no value uses 2022. This means that Chain commands saved before the field existed keep running on 2022.

On 31 October 2027, we will move these commands to 2026-01-01. Switch before then so you can test your chains on 2026.

What changes in 2026

This table identifies the changes to the commands:

Command	Change
Write Sheet Data, Overwrite Sheet Data, Clear Sheet Data, Update Sheet Metadata, Publish Spreadsheet, Delete Spreadsheet	The command starts the action, then checks until it finishes. The Use Async value is ignored. The log records `Checking operation status...` and `Operation completed successfully.` Each check stops after 300 attempts or 10 minutes, whichever comes first. Overwrite Sheet Data checks each part of about 9 MB separately, so a large file can take longer in total.
Delete Spreadsheet	Moves the spreadsheet to the trash, where it can be restored. A Get Spreadsheet Metadata command later in the chain will fail with the message "The selected Spreadsheet is trashed".
Get Sheet Data	Revision is ignored. The command returns the latest data and records `Warning: --revision is not supported by Platform API 2026. The latest sheet data was returned.` in the log. If your chain needs a previous revision, keep the command set to 2022.
Create Spreadsheet	A failure no longer prints the detailed "Errors:" list.
Delete Sheet	A sheet that contains XBRL is rejected with the API message.
Get Sheet Metadata, Update Sheet Metadata, and other commands that take a sheet name	A sheet name past the first page of sheets now resolves.

Other changes

Some "not found" error texts differ between versions, so if a later command checks error text, it can behave differently between versions.
If the API grant lacks file:read or file:write values, the 2026 commands will fail, which can cause the whole chain to fail.
While the configuration dialogs for Get Sheet Data, Write Sheet Data, and Overwrite Sheet Data have a Use Platform API checkbox, if the API version is 2026 these commands will use the 2026 API even if that checkbox is blank.

What stays the same

Inputs and output names on every command, so later commands keep working.
Success messages: "Delete successful", "Update successful", "Publish successful".
Host overrides on the connection. You do not add or change one.

Prerequisites: file:read and file:write

In the 2026 API, these commands check different scopes than on 2022. Unless these grants are updated, a command that works using the 2022 API will fail when using the 2026 API.

Commands that read a spreadsheet need file:read.
Commands that change a spreadsheet need file:write.

Adding Scope values

Adding these scopes requires a Workiva Org Security Admin to adds the scopes to the API grant whose client ID is saved on your Workiva connection:

In the top right, click the user icon, select Admin, then Organization admin.
In the left menu, select Security, then the Provisioning tab.
Find that grant and open it from the Actions menu.
In Scopes, select file:read and file:write and save the grant. The client secret stays the same.

For more information, see Create and manage API grants in Organization Admin.

Steps to switch a chain to 2026

Make sure the grant has file:read and file:write. See Prerequisites.
Open the chain. On every spreadsheet command step, set API Version to 2026.
Save and run the chain.
(Optional, but recommended) Compare the following outputs with an earlier 2022 run:
Rows Written, Cells Written, the Data CSV, and No. of Sheets.

If something is wrong, set the steps back to 2022 and contact Workiva Support.

Use only one API version in a chain Workiva recommends using a single API version for all spreadsheet command steps within a chain; we do not guarantee that mixing and matching multiple API versions will work as expected or desired.

Troubleshooting

Message	What to do
`Credentials do not have the required scope(s): file:read` or `file:write`, with HTML error code 401	The API grant is missing the scope named in the message. Add it as described in Prerequisites, then run the chain again. Until then, set the command to 2022.
`Attempt limit of 300 exceeded` or `Time limit of 10m0s exceeded`	The command did not finish in time. Reduce the data size, or set the command to 2022 and contact Workiva Support.
`Operation failed` or `Operation was cancelled`	Check the spreadsheet and sheet ids. If they are correct, contact Support with the Operation ID shown in the log.
`The selected Spreadsheet is trashed.`	An earlier Delete Spreadsheet step using 2026 moved it to the trash. Restore it, or use another spreadsheet.
`API version must be 2022 or 2026.`	The field holds another value. Set it to 2022 or 2026.

What if I do nothing?

Commands set to 2022 are available until 31 October 2027. On that date, we move them to 2026-01-01. Switch your commands well before then so you have time to test your chains.

Need help?

Contact Workiva Support.

Workiva Support Center