Skip to main content
PATCH
Update playtable field value

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

Cell (playtable field value) sid (pt_vl_…).

Required string length: 18
Pattern: ^pt_vl_

Body

application/json

Request body of update_playtable_field_value.

value
string | null

New cell value (canonical string; per-type parsing lives in the field's ES mapping). null clears the value - the cell finalizes as done with value=null (never empty). Only mutable field - an empty PATCH returns 422 nothing_to_update.

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.