Create playtable field
curl --request POST \
--url https://beta.getsales.io/playtables/v1/api/playtable-fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"playtable_sid": "<string>",
"name": "<string>",
"slug": "<string>",
"payload": {
"formula": "<string>",
"template": "<string>",
"nl_formula": "<string>",
"options": [
"<string>"
],
"currency": "<string>",
"option_colors": {}
},
"add_to_default_view": true
}
'import requests
url = "https://beta.getsales.io/playtables/v1/api/playtable-fields"
payload = {
"playtable_sid": "<string>",
"name": "<string>",
"slug": "<string>",
"payload": {
"formula": "<string>",
"template": "<string>",
"nl_formula": "<string>",
"options": ["<string>"],
"currency": "<string>",
"option_colors": {}
},
"add_to_default_view": True
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
playtable_sid: '<string>',
name: '<string>',
slug: '<string>',
payload: {
formula: '<string>',
template: '<string>',
nl_formula: '<string>',
options: ['<string>'],
currency: '<string>',
option_colors: {}
},
add_to_default_view: true
})
};
fetch('https://beta.getsales.io/playtables/v1/api/playtable-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://beta.getsales.io/playtables/v1/api/playtable-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'playtable_sid' => '<string>',
'name' => '<string>',
'slug' => '<string>',
'payload' => [
'formula' => '<string>',
'template' => '<string>',
'nl_formula' => '<string>',
'options' => [
'<string>'
],
'currency' => '<string>',
'option_colors' => [
]
],
'add_to_default_view' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://beta.getsales.io/playtables/v1/api/playtable-fields"
payload := strings.NewReader("{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"payload\": {\n \"formula\": \"<string>\",\n \"template\": \"<string>\",\n \"nl_formula\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"currency\": \"<string>\",\n \"option_colors\": {}\n },\n \"add_to_default_view\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://beta.getsales.io/playtables/v1/api/playtable-fields")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"payload\": {\n \"formula\": \"<string>\",\n \"template\": \"<string>\",\n \"nl_formula\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"currency\": \"<string>\",\n \"option_colors\": {}\n },\n \"add_to_default_view\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/playtable-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"payload\": {\n \"formula\": \"<string>\",\n \"template\": \"<string>\",\n \"nl_formula\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"currency\": \"<string>\",\n \"option_colors\": {}\n },\n \"add_to_default_view\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"playtable_sid": "<string>",
"object_type": "people",
"name": "<string>",
"slug": "<string>",
"category": "scalar",
"type": "scalar_text",
"payload": {
"formula": "<string>",
"template": "<string>",
"nl_formula": "<string>",
"options": [
"<string>"
],
"currency": "<string>",
"option_colors": {}
},
"config": {
"auto_run": true,
"run_condition": {
"and": [
{}
]
},
"nl_condition": "<string>",
"daily_credit_limit": 1,
"preset_sid": "<string>"
},
"backfill": {
"status": "queued",
"scanned": 1,
"total": 1,
"queued_at": "<string>",
"started_at": "<string>",
"finished_at": "<string>",
"error": "<string>"
},
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}playtable_fields
Create playtable field
Add a column to a playtable: the tool that shapes a table. category is derived from the type prefix, never sent.
Patterns. Find people (a company grid): type action_find_people with payload.prompt saying who to find at each company (1 credit per company searched, a miss free); switch config.auto_run on (its default condition is a company with no people yet) so a company that lands later is searched by itself, and a playtable run searches the companies already there. Add as column: a scalar whose payload.template is one lone variable such as {{record.enrich.company.employees}}; existing rows backfill free, every future run re-derives it; never touch the action field for this. Composed text: a template with {{people.first_name}} or {{company.name}} (catalog attributes) and record.<slug> (a column of this tab), each refused unless it exists. action_waterfall: config.preset_sid (a gtm-api preset) or hand-built payload.steps, never both.
Formulas and templates form dependency edges; a cycle rolls the save back with 422 and context.cycle_path. Idempotent on (playtable_sid, slug): a duplicate answers already_exists true with the existing row (check item.type). Nothing paid runs on create (a playtable run, estimate first, or auto_run does); a scalar formula backfill is free. At most 100 live columns per object_type: the 101st is 422 (context.limit).
Contract:
- MCP tool `create_playtable_field`, registry package `mcp.playtables/playtable_fields`, mount `playtables.columns`.
- Operation `create`, response envelope `create`.
- Flags: none.
POST
/
api
/
playtable-fields
Create playtable field
curl --request POST \
--url https://beta.getsales.io/playtables/v1/api/playtable-fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"playtable_sid": "<string>",
"name": "<string>",
"slug": "<string>",
"payload": {
"formula": "<string>",
"template": "<string>",
"nl_formula": "<string>",
"options": [
"<string>"
],
"currency": "<string>",
"option_colors": {}
},
"add_to_default_view": true
}
'import requests
url = "https://beta.getsales.io/playtables/v1/api/playtable-fields"
payload = {
"playtable_sid": "<string>",
"name": "<string>",
"slug": "<string>",
"payload": {
"formula": "<string>",
"template": "<string>",
"nl_formula": "<string>",
"options": ["<string>"],
"currency": "<string>",
"option_colors": {}
},
"add_to_default_view": True
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
playtable_sid: '<string>',
name: '<string>',
slug: '<string>',
payload: {
formula: '<string>',
template: '<string>',
nl_formula: '<string>',
options: ['<string>'],
currency: '<string>',
option_colors: {}
},
add_to_default_view: true
})
};
fetch('https://beta.getsales.io/playtables/v1/api/playtable-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://beta.getsales.io/playtables/v1/api/playtable-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'playtable_sid' => '<string>',
'name' => '<string>',
'slug' => '<string>',
'payload' => [
'formula' => '<string>',
'template' => '<string>',
'nl_formula' => '<string>',
'options' => [
'<string>'
],
'currency' => '<string>',
'option_colors' => [
]
],
'add_to_default_view' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://beta.getsales.io/playtables/v1/api/playtable-fields"
payload := strings.NewReader("{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"payload\": {\n \"formula\": \"<string>\",\n \"template\": \"<string>\",\n \"nl_formula\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"currency\": \"<string>\",\n \"option_colors\": {}\n },\n \"add_to_default_view\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://beta.getsales.io/playtables/v1/api/playtable-fields")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"payload\": {\n \"formula\": \"<string>\",\n \"template\": \"<string>\",\n \"nl_formula\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"currency\": \"<string>\",\n \"option_colors\": {}\n },\n \"add_to_default_view\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/playtable-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"payload\": {\n \"formula\": \"<string>\",\n \"template\": \"<string>\",\n \"nl_formula\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"currency\": \"<string>\",\n \"option_colors\": {}\n },\n \"add_to_default_view\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"playtable_sid": "<string>",
"object_type": "people",
"name": "<string>",
"slug": "<string>",
"category": "scalar",
"type": "scalar_text",
"payload": {
"formula": "<string>",
"template": "<string>",
"nl_formula": "<string>",
"options": [
"<string>"
],
"currency": "<string>",
"option_colors": {}
},
"config": {
"auto_run": true,
"run_condition": {
"and": [
{}
]
},
"nl_condition": "<string>",
"daily_credit_limit": 1,
"preset_sid": "<string>"
},
"backfill": {
"status": "queued",
"scanned": 1,
"total": 1,
"queued_at": "<string>",
"started_at": "<string>",
"finished_at": "<string>",
"error": "<string>"
},
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
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 scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of create_playtable_field.
Owner playtable sid (pt_tb_…).
Required string length:
18Pattern:
^pt_tb_Object grid this field belongs to: people or company rows. Fixed at create.
Available options:
people, company The category derives from the prefix. Scalar and the generic action types fit both grids; action_find_people is company-only. Widgets: data_source, tags, last_touch, activity on both; deal_size, website, people_summary company-only; the rest people-only.
Available options:
scalar_text, scalar_number, scalar_currency, scalar_date, scalar_url, scalar_checkbox, scalar_select, scalar_multiselect, scalar_image, widget_data_source, widget_tags, widget_active_workflows, widget_notes, widget_company, widget_linkedin_id, widget_linkedin_channel, widget_work_email, widget_personal_email, widget_email_channel, widget_phones, widget_phone_channel, widget_last_touch, widget_activity, widget_deal_size, widget_website, widget_people_summary, widget_ai_sdr, action_ai_research, action_waterfall, action_gtm_tool, action_find_people Display label; slug is derived from it when slug is omitted.
Required string length:
1 - 255Template-variable name, immutable after create: formulas read record., prompts {{record.}}. Default: the slugified name (a collision takes _2).
Required string length:
1 - 64Pattern:
^[a-z][a-z0-9_]{0,63}$Shape must match type. REQUIRED for action_* types; default: {} (widget) / all-null scalar payload.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
Action fields only. Omit for defaults (auto_run:false, everything else null).
Show child attributes
Show child attributes
true also appends the column to its grid's default view, so people see it without an update_playtable_view call. Idempotent: a column already in the layout stays where it is. Default false: the column exists but no view shows it.