Skip to main content
PATCH
Update playtable field

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Playtable field sid (pt_fd_…).

Required string length: 18
Pattern: ^pt_fd_

Body

application/json

Request body of update_playtable_field.

name
string

New display label (1..255); the slug never changes.

Required string length: 1 - 255
type
enum<string>

Type change of a scalar column (scalar to scalar only): every cell is re-cast, unconvertible values are flagged is_not_valid, the ES slot moves. Widgets and actions never convert.

Available options:
scalar_text,
scalar_number,
scalar_currency,
scalar_date,
scalar_url,
scalar_checkbox,
scalar_select,
scalar_multiselect,
scalar_image
payload
object

Full replacement; shape must still match the row's immutable type.

config
object

Full replacement; action fields only (non-default on scalar/widget → 422).

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.