Skip to main content
POST
Preview playtable field condition

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 preview_playtable_field_condition.

playtable_sid
string
required

Owner playtable sid (pt_tb_…).

Required string length: 18
Pattern: ^pt_tb_
object_type
enum<string>
required

Which rows the gate is about, people or company: the tab the draft column belongs to.

Available options:
people,
company
object_sids
string[]
required

1..100 distinct row sids of the tab (cr_pp_… or cr_co_…) to try the gate on.

Required array length: 1 - 100 elements
Required string length: 18
run_condition

The unsaved gate, the shape config.run_condition takes; null or absent = no gate, every row runs. An unknown record. or a bad atom is 422 here, not at save.

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required