table

Update an existing table

patch/v1/org/{orgId}/table/{tableId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/table/{tableId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

tableIdstring required

Table id or name

Request body

namestring

name of table

labelstring

human readable label for the table

labelColumnIdstring

if set, use this column id as the label when referencing rows

effectiveDatedboolean

whether or not the table is time tracked with effective dates (allows time travel or not). If false, then the values set in the table will be the same across all dates.

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

base sensitivity of this table and entities in it -- should be either ORG or HIGH

Example request

{
  "name": "budget-data",
  "label": "Budget Data",
  "labelColumnId": "588f7ee98f138b19220041a7",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ]
}

Response

table updated

Changes

No recorded changes to this operation across all 20 revisions of this API.