Update Table Sheet - PromptLayer

Update Sheet

curl --request PATCH \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "title": "<string>",
  "index": 123
}
'

{
  "success": true,
  "sheet": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": 123,
    "title": "<string>",
    "index": 123,
    "row_count": 123,
    "version_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "version": 123
}

PATCH

api

public

tables

{table_id}

sheets

{sheet_id}

Update Sheet

curl --request PATCH \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "title": "<string>",
  "index": 123
}
'

{
  "success": true,
  "sheet": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": 123,
    "title": "<string>",
    "index": 123,
    "row_count": 123,
    "version_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "version": 123
}

Update a sheet in a Table. Use title to rename the sheet and index to change its zero-based position in the Table. Updating a sheet creates a new sheet version.

Authorizations

X-API-KEY

string

header

required

Path Parameters

table_id

string<uuid>

required

sheet_id

string<uuid>

required

Body

application/json

title

string | null

index

integer | null

New display position within the table (0-based).

Response

Sheet updated

success

boolean

sheet

object

A sheet within a Table.

Show child attributes

version

integer

Current sheet version_count for this response. It matches the sheet's version_count after any committed changes.

⌘I