TRtrydock
Surfaces

Rename, reslug, reorder, OR replace a surface's column schema

Changed on

Rename, change the URL slug, move a surface within its workspace's tab strip, OR replace the column schema (table surfaces only). Pass any subset of name, slug, position, columns. Position uses 0-based indexing and other tabs shift to keep positions contiguous. Column replace fires surface.columns_updated; row.data keys not in the new schema are preserved on disk. Editor role required. Slug renames preserve old URLs via the surface alias table.

patch/api/workspaces/{slug}/surfaces/{surfaceSlug}

Request

  • Base URL
    https://trydock.ai
  • Auth
    HTTP bearer

Path parameters

slugstring required
surfaceSlugstring required

Request body

namestring

New display name.

slugstring

New URL slug. Lowercase kebab-case, 3-64 chars. Must be unique within the workspace; old slug stays redirectable via the surface alias table.

positioninteger

Optional reorder. Equivalent to POST /surfaces/{slug}/move when only repositioning.

Response

Updated.

Example response

{
  "surface": {
    "id": "srf_01J5Z…",
    "slug": "table-2",
    "name": "Backlog"
  }
}

Changes

  • dd96ae96a412Revision changes
    • info

      added the new optional request property //

    • info

      added the optional property /// to the response with the status