Create a row and get the URL in the response.

scottapi

Hi

At https://developers.smartsheet.com/api/smartsheet/openapi/rows/rows-addtosheet the documentation says that a 'permaLink' attribute can be returned, "if the include query string parameter contains rowPermalink".

So I've set my POST request to:

/sheets/#{sheet_id}/rows?include=rowPermalink

and sadly had no luck. I have also tried including this value in the body JSON as below:

{
include: "rowPermalink",
cells: [
{ columnId: 111111, value: "Text" }
]
}

But again, this does not return the url.

Can anyone point me in the right direction on how to have this endpoint return the URL to the created row?

Many thanks

Scott

ShaunW

hi looking on chatgpt i found this, it may help, i find that it it doesn't it will be pretty close!

the issue isn’t your syntax so much as how Smartsheet applies include=rowPermalink.

The key point (this is the gotcha)

👉 rowPermalink is NOT returned on the Add Rows (POST) response, even though the docs mention it as an includable attribute.

In practice, include=rowPermalink only works on GET operations, not on POST /rows.

So:

• ✅ Your endpoint is valid
• ❌ Smartsheet simply doesn’t return permalinks on row creation

This is a known limitation/quirk of the Smartsheet API.

What does work (recommended approach)

Step 1: Create the row (POST)

POST /sheets/{sheetId}/rows

Response will include:

• row.id ✅
• No permalink ❌

Example response fragment:

{  "result": [    {      "id": 987654321,      "cells": [...]    }  ]}

Step 2: Retrieve the row permalink (GET)

Now fetch the row using the ID returned above:

GET /sheets/{sheetId}/rows/{rowId}?include=rowPermalink

This will return:

{  "id": 987654321,  "permalink": "https://app.smartsheet.com/b/home?lx=..."}

Why your body-based include didn’t work

{  "include": "rowPermalink",  "cells": [...]}

• include is only a query-string parameter
• It is ignored in request bodies
• Even in the query string, POST /rows does not honor it

So unfortunately there’s no single-call solution.

Practical workaround pattern

Most integrations do this:

1. POST rows
2. Extract returned row.id
3. GET row with include=rowPermalink
4. Cache the permalink if needed

This is the only reliable way today.

TL;DR

• ❌ rowPermalink is not returned on POST /rows
• ✅ It is returned on GET row(s) with include=rowPermalink
• ✅ Two-step approach is required