Skip to main content
POST
Write 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.

Body

application/json

Request body of write_playtable_field_value.

playtable_field_sid
string
required

The column (pt_fd_…); the table and the object type derive from it. Unknown or another team's: 404.

Required string length: 18
Pattern: ^pt_fd_
object_sid
string
required

The row: a person (cr_pp_…) or a company (cr_co_…) that belongs to the column's table (422 otherwise).

Required string length: 18
Pattern: ^cr_(pp|co)_
value
string | null
required

The value to write, canonical string (max 65535). The key is required: null clears the cell, which stays done with value null, never empty.

Maximum string length: 65535

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.