Create play
curl --request POST \
--url https://beta.getsales.io/playtables/v1/api/plays \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"playtable_sid": "<string>",
"name": "<string>",
"action": {
"prompt": "<string>",
"per_company_limit": 13,
"workflow_sid": "<string>",
"moments": {},
"do": "<string>",
"per_person_weekly_cap": 7,
"sender_profile_sid": "<string>",
"pages": [
"<string>"
]
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": true
},
"audience": "<unknown>",
"enabled": true,
"daily_credit_limit": 2
}
'import requests
url = "https://beta.getsales.io/playtables/v1/api/plays"
payload = {
"playtable_sid": "<string>",
"name": "<string>",
"action": {
"prompt": "<string>",
"per_company_limit": 13,
"workflow_sid": "<string>",
"moments": {},
"do": "<string>",
"per_person_weekly_cap": 7,
"sender_profile_sid": "<string>",
"pages": ["<string>"]
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": True
},
"audience": "<unknown>",
"enabled": True,
"daily_credit_limit": 2
}
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>',
action: {
prompt: '<string>',
per_company_limit: 13,
workflow_sid: '<string>',
moments: {},
do: '<string>',
per_person_weekly_cap: 7,
sender_profile_sid: '<string>',
pages: ['<string>']
},
watch: {profile_days: 7, company_days: 30, posts_days: 1, moments: true},
audience: '<unknown>',
enabled: true,
daily_credit_limit: 2
})
};
fetch('https://beta.getsales.io/playtables/v1/api/plays', 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/plays",
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>',
'action' => [
'prompt' => '<string>',
'per_company_limit' => 13,
'workflow_sid' => '<string>',
'moments' => [
],
'do' => '<string>',
'per_person_weekly_cap' => 7,
'sender_profile_sid' => '<string>',
'pages' => [
'<string>'
]
],
'watch' => [
'profile_days' => 7,
'company_days' => 30,
'posts_days' => 1,
'moments' => true
],
'audience' => '<unknown>',
'enabled' => true,
'daily_credit_limit' => 2
]),
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/plays"
payload := strings.NewReader("{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"per_person_weekly_cap\": 7,\n \"sender_profile_sid\": \"<string>\",\n \"pages\": [\n \"<string>\"\n ]\n },\n \"watch\": {\n \"profile_days\": 7,\n \"company_days\": 30,\n \"posts_days\": 1,\n \"moments\": true\n },\n \"audience\": \"<unknown>\",\n \"enabled\": true,\n \"daily_credit_limit\": 2\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/plays")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"per_person_weekly_cap\": 7,\n \"sender_profile_sid\": \"<string>\",\n \"pages\": [\n \"<string>\"\n ]\n },\n \"watch\": {\n \"profile_days\": 7,\n \"company_days\": 30,\n \"posts_days\": 1,\n \"moments\": true\n },\n \"audience\": \"<unknown>\",\n \"enabled\": true,\n \"daily_credit_limit\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/plays")
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 \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"per_person_weekly_cap\": 7,\n \"sender_profile_sid\": \"<string>\",\n \"pages\": [\n \"<string>\"\n ]\n },\n \"watch\": {\n \"profile_days\": 7,\n \"company_days\": 30,\n \"posts_days\": 1,\n \"moments\": true\n },\n \"audience\": \"<unknown>\",\n \"enabled\": true,\n \"daily_credit_limit\": 2\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"playtable_sid": "<string>",
"catalog_key": "keep_fresh",
"name": "<string>",
"object_type": "people",
"action_type": "find_people",
"action": {
"prompt": "<string>",
"per_company_limit": 123,
"data_source_sid": "<string>"
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": true
},
"cadence": "manual",
"mode": "ask_me",
"enabled": true,
"enabled_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>"
},
"enabled_at": "<string>",
"daily_credit_limit": 123,
"last_run_at": "<string>",
"last_run_counts": {
"matched": 1,
"acted": 1,
"skipped": 1,
"credits": 1
},
"next_run_at": "<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>",
"audience": "<unknown>"
},
"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>"
}
}plays
Create play
Create a play. The usual way: catalog_key alone (plus action.workflow_sid for a people play), which births the playbook’s entry on the table as it is, once (a second create answers the existing row); then estimate_play, one sentence with the count and the credits, and run_play or the switch. The other way, a play saved from a view: an audience of one tab (the same filter AST a saved view carries), one action and a cadence. find_people over a company audience: the play owns a find_people source born at the first run; add_to_workflow over a people audience: the play owns a manual source born when the workflow is named (here, or later with update_play). A manual play runs on run_play (the click is the consent); a daily play runs by itself while enabled, and switching it on is the consent: estimate_play first, then say what one run does and what a day may spend (daily_credit_limit) in one sentence, and switch it on only after the yes. Refusals: an action that does not fit the object, a switch or a ceiling where it does not apply, a people play switched on with no workflow (422), an archived workflow (409 conflict), a workflow with no published version (409 invalid_transition), an audience the tab refuses (422 under audience).
Contract:
- MCP tool
create_play, registry packagemcp.playtables/plays, mountplaytables.pipeline. - Operation
create, response envelopecreate. - Flags: none.
POST
/
api
/
plays
Create play
curl --request POST \
--url https://beta.getsales.io/playtables/v1/api/plays \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"playtable_sid": "<string>",
"name": "<string>",
"action": {
"prompt": "<string>",
"per_company_limit": 13,
"workflow_sid": "<string>",
"moments": {},
"do": "<string>",
"per_person_weekly_cap": 7,
"sender_profile_sid": "<string>",
"pages": [
"<string>"
]
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": true
},
"audience": "<unknown>",
"enabled": true,
"daily_credit_limit": 2
}
'import requests
url = "https://beta.getsales.io/playtables/v1/api/plays"
payload = {
"playtable_sid": "<string>",
"name": "<string>",
"action": {
"prompt": "<string>",
"per_company_limit": 13,
"workflow_sid": "<string>",
"moments": {},
"do": "<string>",
"per_person_weekly_cap": 7,
"sender_profile_sid": "<string>",
"pages": ["<string>"]
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": True
},
"audience": "<unknown>",
"enabled": True,
"daily_credit_limit": 2
}
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>',
action: {
prompt: '<string>',
per_company_limit: 13,
workflow_sid: '<string>',
moments: {},
do: '<string>',
per_person_weekly_cap: 7,
sender_profile_sid: '<string>',
pages: ['<string>']
},
watch: {profile_days: 7, company_days: 30, posts_days: 1, moments: true},
audience: '<unknown>',
enabled: true,
daily_credit_limit: 2
})
};
fetch('https://beta.getsales.io/playtables/v1/api/plays', 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/plays",
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>',
'action' => [
'prompt' => '<string>',
'per_company_limit' => 13,
'workflow_sid' => '<string>',
'moments' => [
],
'do' => '<string>',
'per_person_weekly_cap' => 7,
'sender_profile_sid' => '<string>',
'pages' => [
'<string>'
]
],
'watch' => [
'profile_days' => 7,
'company_days' => 30,
'posts_days' => 1,
'moments' => true
],
'audience' => '<unknown>',
'enabled' => true,
'daily_credit_limit' => 2
]),
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/plays"
payload := strings.NewReader("{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"per_person_weekly_cap\": 7,\n \"sender_profile_sid\": \"<string>\",\n \"pages\": [\n \"<string>\"\n ]\n },\n \"watch\": {\n \"profile_days\": 7,\n \"company_days\": 30,\n \"posts_days\": 1,\n \"moments\": true\n },\n \"audience\": \"<unknown>\",\n \"enabled\": true,\n \"daily_credit_limit\": 2\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/plays")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playtable_sid\": \"<string>\",\n \"name\": \"<string>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"per_person_weekly_cap\": 7,\n \"sender_profile_sid\": \"<string>\",\n \"pages\": [\n \"<string>\"\n ]\n },\n \"watch\": {\n \"profile_days\": 7,\n \"company_days\": 30,\n \"posts_days\": 1,\n \"moments\": true\n },\n \"audience\": \"<unknown>\",\n \"enabled\": true,\n \"daily_credit_limit\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/plays")
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 \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"per_person_weekly_cap\": 7,\n \"sender_profile_sid\": \"<string>\",\n \"pages\": [\n \"<string>\"\n ]\n },\n \"watch\": {\n \"profile_days\": 7,\n \"company_days\": 30,\n \"posts_days\": 1,\n \"moments\": true\n },\n \"audience\": \"<unknown>\",\n \"enabled\": true,\n \"daily_credit_limit\": 2\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"playtable_sid": "<string>",
"catalog_key": "keep_fresh",
"name": "<string>",
"object_type": "people",
"action_type": "find_people",
"action": {
"prompt": "<string>",
"per_company_limit": 123,
"data_source_sid": "<string>"
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": true
},
"cadence": "manual",
"mode": "ask_me",
"enabled": true,
"enabled_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>"
},
"enabled_at": "<string>",
"daily_credit_limit": 123,
"last_run_at": "<string>",
"last_run_counts": {
"matched": 1,
"acted": 1,
"skipped": 1,
"credits": 1
},
"next_run_at": "<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>",
"audience": "<unknown>"
},
"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_play.
The table the play lives in; its audience is resolved inside it.
Required string length:
18Pattern:
^pt_tb_A playbook play: the entry gives object, audience, action and name, so send only the table (plus action.workflow_sid for a people play; cadence, switch, ceiling if wanted). Born once per table: a repeat answers the existing row, already_exists true.
Available options:
keep_fresh, congratulate, on_job_change, engage_posts, on_website_visit, find_people_empty, top_up_thin, top_up_silent, top_up_no_reply, top_up_exhausted, find_decision_maker, reengage_dormant, reach_untouched Required without catalog_key; with it, a name over the entry's.
Required string length:
1 - 255Required without catalog_key. What the audience selects: company for find_people, people for add_to_workflow (422 otherwise).
Available options:
people, company Required without catalog_key.
Available options:
find_people, add_to_workflow, refresh, congratulate, on_job_change, engage_posts, on_website_visit The action's parameters (required without catalog_key), the keys of the action_type over the entry's defaults. The sids of the play's sources are never sent: the server births them. A workflow a typed action names must be the team's, live and published.
Show child attributes
Show child attributes
What the play keeps refreshed; absent on a playbook play = the entry's; a cadence outside the product's own is 422; null = nothing.
Show child attributes
Show child attributes
ask_me | automatic; absent on a playbook play = the entry's (ask me for the plays that act).
Available options:
ask_me, automatic Without catalog_key: the tab's filter AST, validated like a saved view. Signals by name: {field: signals, op: {in: [no_engagement]}}; the category: {field: pipeline_stage_category, op: {in: [nurture]}}; several under {and: [...]}. Omit = the whole tab.
Default manual.
Available options:
manual, daily daily only: true is the consent, stated with the estimate; the first run follows within the minute. 422 on a manual play.
find_people only: what one day may spend. 422 on an add_to_workflow play.
Required range:
x >= 1