Skip to main content
Ctrl+K
 - Home  - Home
Workiva API Versions
  • Versions
  • 2026-01-01
  • 2022-01-01
  • Wdata API
  • Chains API
  • 2022-01-01
  • API Details
    • Setup
    • Authentication
    • Code Generation
    • Digests
    • Errors
    • Expansion
    • Filtering & Sorting
    • Headers
    • Limits
    • Pagination
    • PATCH Updates
    • Versioning
    • 2026-01-01 Upgrade Guide
    • Legacy Spreadsheets API Migration Guide
  • Changelog
  • IAM
    • Retrieve a token
  • Admin
    • Activities
      • Retrieve a single activity
      • Retrieve a list of activity actions
      • Retrieve a single activity action
      • Retrieve a list of activities for an organization
      • Retrieve a list of activities for a workspace
    • Reports
      • List organization users
  • Platform
    • Documents
      • Retrieve a list of documents
      • Retrieve a single document
      • Initiate a document export
      • Retrieve a list of sections
      • Create a new section in a document
      • Delete a single section
      • Retrieve a single section
      • Partially update a single section
      • Update a single section
      • Copy section
    • Files
      • Retrieve a list of files
      • Create a new file
      • Initiate a file import
      • Retrieve a single file
      • Partially update a single file
      • Update a single file
    • Graph
      • Introduction to Graph Endpoints
      • Create a new record
      • Delete a single record
      • Update a single record
      • Create new record edits
      • Retrieve a list of records
      • Retrieve a single record
      • Retrieve the CSV of a saved report
      • Initiate a graph report export
      • Retrieve a list of types
      • Retrieve a single type
    • Operations
      • Retrieve a single operation
    • Presentations
      • Initiate a presentation export
    • PlatformSpreadsheets
      • Retrieve a list of spreadsheets
      • Retrieve a single spreadsheet
      • Retrieve a list of datasets
      • Bulk upsert of datasets
      • Initiate a spreadsheet export
      • Retrieve a list of sheets
      • Create a new sheet in a spreadsheet
      • Delete a single sheet
      • Retrieve a single sheet
      • Partially update a single sheet
      • Update a single sheet
      • Copy sheet
      • Delete a single dataset
      • Retrieve data from a sheet
      • Update sheet content
      • Retrieve a list of range values
      • Update values in a range
    • Tasks
      • Retrieve a list of tasks
      • Create a new task
      • Delete a single task
      • Retrieve a single task
      • Partially update a single task
      • Update a single task
    • Test Forms
      • Retrieve a list of test forms
      • Retrieve a single test form
      • Initiate a test form export
      • Retrieve a list of test phases
      • Retrive a single test phase
      • Initiate a test phase attachment upload
      • Retrieve a list of test phase attachments
      • Retrieve a single test phase attachment
      • Initiate a test phase attachment download
      • Initiate a test phase attachment export
      • Retrieve a list of matrices
      • Create a new matrix
      • Retrieve a single matrix
      • Initiate a matrix attachment upload
      • Retrieve a list of matrix attachments
      • Retrieve a single matrix attachment
      • Initiate a matrix attachment download
      • Initiate an export of a matrix attachment
      • Retrieve a list of samples
      • Create a new sample
      • Insert samples
      • Update samples
      • Retrieve a single sample
      • Partially update a single sample
      • Update a single sample
      • Initiate an upload of a sample attachment
      • Retrieve a list of sample attachments
      • Retrieve a single sample attachment
      • Initiate a download of a sample attachment
      • Initiate an export of a sample attachment
    • PlatformUsers
      • Retrieve a list of users
  • Prototype Admin
    • Admin
      • Retrieve a list of organizations
      • Retrieve a single organization
      • Update a single organization
      • Retrieve available roles within an organization
      • Retrieve available solutions within an organization
      • Retrieve list of an organizations users
      • Create a new organization User
      • Assign existing user to organization
      • Delete an organization user
      • Retrieve a single user in an organization
      • Partially update a single user in an organization
      • List Roles assigned to an Organization User
      • Assign roles for an Organization User
      • Revoke roles for an Organization User
      • Retrieve list of workspaces
      • Create a new workspace
      • Retrieve a single workspace
      • Update a single workspace
      • Retrieve list of groups
      • Create a new group in a workspace
      • Delete a single group
      • Retrieve a single group
      • Update a single group
      • Retrieve list of group members
      • Modify members in a group
      • Retrieve list of workspace memberships
      • Create a new workspace membership
      • Create a new workspace membership with options
      • Delete a workspace membership
      • Retrieve a single workspace membership
      • Retrieve available roles for a workspace membership
      • Assign roles for a Workspace Membership
      • Revoke roles for a Workspace Membership
      • Retrieve available roles within a workspace
      • Retrieve available solutions within a workspace
      • Retrieve a solution by id
  • Prototype Platform
    • Audits
      • Retrieve a list of audits
      • Retrieve a single audit
      • Initiate an audit attachment upload
      • Retrieve a list of audit attachments
      • Retrieve a single audit attachment
      • Initiate an audit attachment download
      • Initiate an audit attachment export
      • Initiate an audit export
      • Retrieve a list of procedures
      • Retrieve a single procedure
      • Initiate a procedure attachment upload
      • Retrieve a list of procedure attachments
      • Retrieve a single procedure attachment
      • Initiate a procedure attachment download
      • Initiate a procedure attachment export
      • Retrieve a list of matrices
      • Create a new matrix
      • Retrieve a single matrix
      • Initiate a matrix attachment upload
      • Retrieve a list of matrix attachments
      • Retrieve a single matrix attachment
      • Initiate a matrix attachment download
      • Initiate an export of a matrix attachment
      • Retrieve a list of samples
      • Create a new sample
      • Insert samples
      • Update samples
      • Retrieve a single sample
      • Partially update properties of a single sample
      • Update a single sample
      • Initiate an upload of a sample attachment
      • Retrieve a list of sample attachments
      • Retrieve a single sample attachment
      • Initiate a download of a sample attachment
      • Initiate an export of a sample attachment
    • Content
      • Introduction to Content Endpoints
      • Image
        • Initiate upload of an image
        • Retrieve an image by id
      • Rich Text
        • Initiate edits to rich text
        • Retrieve rich text paragraphs
        • Initiate duplication edits to rich text
      • Tables
        • Retrieve table cell content
        • Initiate edits to table cells
        • Retrieve table column properties
        • Initiate edit to a table
        • Reapply filters to the table
        • Retrieve table row properties
        • Retrieve a table’s properties by id
        • Partially update a table’s properties
      • Style Guides
        • Retrieve a style guide by id
        • Initiate a style guide export
        • Initiate import of a style guide
      • Anchors
        • Retrieve a list of drawing anchors
        • Retrieve a list of rich text anchors
        • Initiate creation of a new rich text anchor
        • Retrieve a rich text anchor by id
        • Retrieve a list of rich text anchor extensions
        • Retrieve an anchor by ID
        • Retrieve a list of table anchors
        • Initiate creation of a new table anchor
        • Retrieve a table anchor by ID
        • Retrieve a list of table anchor extensions
      • Drawings
        • Retrieve drawing elements by id
        • Retrieve a drawing anchor by ID
        • Retrieve a list of drawing anchor extensions
      • Links
        • Retrieve a destination link by id
        • Initiate a destination link conversion
        • Initiate edits to rich text links
        • Initiate edit to table links
      • Range Links
        • Retrieve a list of range links
        • Retrieve a range link by id
        • Retrieve range link destinations for a source
        • Initiate range links edits on a table
    • Custom Fields
      • Introduction to Custom Fields Endpoints
      • Retrieve a customSchema
      • Partially update a customSchema
      • Get Custom Fields
      • Create Custom Field
      • Get Custom Field
      • Update Custom Field
    • PrototypeDocuments
      • Retrieve a list of documents
      • Retrieve a single document
      • Update a single document
      • Reapply filters to the document
      • Initiate publication of links in a document
      • Retrieve a list of milestones for a document
      • Retrieve permissions for a document
      • Modify permissions on a document
      • Retrieve a list of sections
      • Create a new section in a document
      • Initiate sections edits
      • Delete a single section
      • Retrieve a single section
      • Partially update a single section
      • Update a single section
      • Retrieve permissions for a section in a document
      • Modify permissions on a given section of a document
    • PrototypeFiles
      • Retrieve a list of files
      • Create a new file
      • Initiate a file export
      • Initiate a file import
      • Retrieve a list of trashed files
      • Retrieve a single file
      • Partially update a single file
      • Update a single file
      • Initiate a file copy
      • Retrieve permissions for a file
      • Modify permissions on a file
      • Initiate restoration of a single file
      • Initiate trash of a single file
      • Initiate a file export by ID
    • PrototypeMilestones
      • Introduction to Milestones Endpoints
      • Retrieve a milestone by id
      • Deletes a milestone
      • Partially updates a milestone
      • Initiates a request to create a new milestone
    • PrototypeOperations
      • Introduction to Operations
      • Retrieve a single operation
      • Retrieve the results of a batch upsertion of metric values
      • Retrieve copy file results for a single operation
      • Retrieves the results from a destination link source conversion.
      • Retrieve results for a image upload
      • Retrieve import file results for a single operation
      • Retrieve results for a range link edit
      • Retrieve results for a rich text batch edit
      • Retrieve results for a rich text anchor creation
      • Retrieve results for a rich text links batch edit
      • Retrieve results for a table anchor creation
      • Retrieve results for a table cell edit
      • Retrieve results for a table edit
      • Retrieve results for a table links edit
      • Retrieve results for a table reapply filter
      • Retrieve results for a milestone creation
      • Retrieve results for a patch document
      • Retrieve results for a patch presentation
      • Retrieve results for a patch Section
      • Retrieve results for a patch sheet
      • Retrieve results for a patch slide layout
      • Retrieve results for a patch slide
      • Retrieve results for a patch spreadsheet
      • Retrieve results for a patch table properties
      • Retrieve results for a rich text duplication edit
    • Permissions
      • Introduction to Permissions Endpoints
      • Retrieve a list of all available permissions
      • Retrieve a single permission
    • PrototypePresentations
      • Retrieve a list of presentations
      • Retrieve a single presentation
      • Update a single presentation
      • Reapply filters to the presentation
      • Initiate publication of links in a presentation
      • Retrieve a list of milestones for a presentation
      • Retrieve permissions for a presentation
      • Modify permissions on a presentation
      • Retrieve a list of slide layouts
      • Create a new slide layout in a presentation
      • Delete a single slide layout
      • Retrieve a single slide layout
      • Partially update a single slide layout
      • Copy slide layout
      • Retrieve a list of slides
      • Create a new slide in a presentation
      • Delete a single slide
      • Retrieve a single slide
      • Partially update a single slide
      • Initiate a slide copy
      • Retrieve permissions for a slide in a presentation
      • Modify permissions on a given slide of a presentation
    • Sustainability
      • Retrieve a list of programs
      • Create a new program
      • Retrieve a single program
      • Partially update a single program
      • Retrieve a list of dimensions
      • Create a new dimension
      • Retrieve a single dimension
      • Partially update a single dimension
      • Retrieve a list of metrics
      • Create a new metric
      • Delete a single metric
      • Retrieve a single metric
      • Partially update a single metric
      • Retrieve a list of metric values
      • Create a new metric value
      • Initiate a batch deletion of metric values
      • Initiate a batch upsertion of metric values
      • Retrieve permissions for a program
      • Modify permissions on a program
      • Retrieve a list of topics
      • Create a new topic
      • Delete a single topic
      • Retrieve a single topic
      • Partially update a single topic
      • Delete a single metric value
      • Retrieve a single metric value
      • Partially update a single metric value
    • Scripts
      • Retrieve a list of scripts
      • Create a new script
      • Retrieve a single script
      • Partially update a single script
      • Initiate a script execution
      • Retrieve permissions for given script
      • Modify permissions on a script
      • Retrieve a list of runs
      • Retrieve a single run
      • Initiate a run cancellation
      • Initiate a download of run logs
      • Initiate a download of run output
      • Retrieve a list of sources
      • Create a new source
      • Delete a single source
      • Retrieve a single source
      • Partially update a single source
      • Initiate a content download
      • Initiate a content upload
    • PrototypeSpreadsheets
      • Retrieve a list of spreadsheets
      • Retrieve a single spreadsheet
      • Update a single spreadsheet
      • Reapply filters to the spreadsheet
      • Initiate publication of links in a spreadsheet
      • Retrieve a list of milestones for a spreadsheet
      • Retrieve permissions for a spreadsheet
      • Modify permissions on a spreadsheet
      • Retrieve a list of sheets
      • Retrieve a single sheet
      • Partially update a single sheet
      • Update a single sheet
      • Retrieve permissions for a sheet in a spreadsheet
      • Modify permissions on a given sheet of a spreadsheet
      • Update sheet content
    • PrototypeTasks
      • Retrieve a list of tasks
      • Create a new task
      • Delete a single task
      • Retrieve a single task
      • Partially update a single task
      • Initiate a task action submission
  • Legacy Spreadsheets
    • LegacySpreadsheetsAsync
      • Asynchronously write data to a region
      • Return job data for an asynchronous operation
    • LegacySpreadsheets
      • Create a new spreadsheet
      • Delete a spreadsheet
      • Return spreadsheet properties
      • Update spreadsheet properties
      • Publish links in a spreadsheet
      • Return a list of all sheets in the outline and their properties
      • Create a new sheet
      • Delete a sheet and all of its child sheets (recursively)
      • Return sheet properties
      • Update sheet properties
      • Return data from a region
      • Write data to a region
  • Additional Objects

Publish links in a spreadsheet

Table Of Contents

  • Description
    • Parameters
    • Body parameter example
    • Code Samples
    • Returns
      • 200 - OK
      • 400 - Bad Request
      • 401 - Unauthorized
      • 403 - Forbidden
      • 404 - Not Found
      • 429 - Too Many Requests
      • 500 - Internal Server Error
      • Example Responses

Publish links in a spreadsheet#

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2029-01-31.

Description#

Publishes the links in a spreadsheet — either all (as spreadsheet owner) or only one’s own. Note: Publication of only one’s own links requires the data_tables|r scope. Publication of all links (as a spreadsheet owner) requires data_tables|w.

Note: This endpoint is rate-limited. You may experience rates as low as 20 requests per minute. This rate is shared across your workspace. When you encounter a 429, examine the Retry-After header and retry after that many seconds.

POST /spreadsheets/v1/spreadsheets/{spreadsheetId}/publish

Required OAuth Scopes

data_tables|r,data_tables|w

Parameters#

Parameter

In

Type

Required

Description

X-Version

header

string

false

Version of the API (2022-01-01)

spreadsheetId

path

string

true

The unique identifier of the spreadsheet

body

body

PublishBody

false

Body parameter example#

{
  "all": false
}

Code Samples#

curl -X POST https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/publish \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'
http POST https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/publish \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/publish" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'
import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/publish', headers = headers)

print(r.json())

Returns#

200 - OK#

No content returned.

400 - Bad Request#

An ErrorResponse object containing a message and list of errors.

401 - Unauthorized#

An ErrorResponse object containing a message and list of errors.

403 - Forbidden#

An ErrorResponse object containing a message and list of errors.

404 - Not Found#

An ErrorResponse object containing a message and list of errors.

429 - Too Many Requests#

An ErrorResponse object containing a message and list of errors.

500 - Internal Server Error#

An ErrorResponse object containing a message and list of errors.

Example Responses#

{
  "message": "Operation successful",
  "request_id": "d6a6ce3f-f120-4104-9587-a5a2dc45626c"
}

previous

Update spreadsheet properties

next

Return a list of all sheets in the outline and their properties

Table Of Contents
  • Description
    • Parameters
    • Body parameter example
    • Code Samples
    • Returns
      • 200 - OK
      • 400 - Bad Request
      • 401 - Unauthorized
      • 403 - Forbidden
      • 404 - Not Found
      • 429 - Too Many Requests
      • 500 - Internal Server Error
      • Example Responses

© 2026 Workiva: Legal | Privacy Policy | Sitemap

Last updated on Apr 02, 2026.

See Workiva
for yourself

Request Demo

Platform

  • Why Workiva
  • Platform Overview
  • Data Management
  • Generative AI
  • Security
  • Demo Center
  • Partner Network
  • Contact Us

Solutions

  • All Solutions
  • Accounting & Finance Teams
  • Audit & Risk Teams
  • ESG & Sustainability
  • Legal Teams

All Solutions

  • Annual and Interim Financial Reporting
  • Board Report Creation
  • Capital Market Transactions
  • Enterprise Risk management
  • ESEF Reporting
  • ESG Reporting
  • FERC Reporting
  • Financial Close Reporting
  • Financial Statement Automation
  • Governance, Risk, and Compliance
  • Internal Audit Management
  • Internal Controls Management
  • IPO
  • IT Risk and Compliance
  • Management Reporting
  • Policy Management
  • Product Line and Business Unit Reporting
  • SEC Reporting
  • SEDAR Reporting
  • SOX Compliance
  • Statutory Reporting
  • Tax Reporting
  • Transfer Pricing
  • XBRL and iXBRL

Resources

  • Resource Center
  • Blog
  • Customer Stories
  • Events & Webinars
  • Workiva Amplify
  • Help Center
  • Support
  • Community
  • Learning Hub

Company

  • About Us
  • Leadership
  • Diversity, Equity, & Inclusion
  • Careers
  • Newsroom & Press Releases
  • Investor Relations
  • Financial Reports

Follow Us

Learn About

  • What is Financial Reporting?
  • What is Data Management?
  • What is Financial Reporting + GRC?
  • What is ESG + Financial Reporting?
  • What is GRC + ESG?

©2026 Workiva

Legal

Privacy Policy

Sitemap

2900 University Blvd
Ames, IA 50010

SICPA-SOC