Update play
curl --request PATCH \
--url https://beta.getsales.io/playtables/v1/api/plays/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"name": "<string>",
"audience": "<unknown>",
"action": {
"prompt": "<string>",
"per_company_limit": 13,
"workflow_sid": "<string>",
"moments": {},
"do": "<string>",
"like": {
"on": true
},
"comment": {
"on": true,
"brief": "<string>"
},
"per_person_weekly_cap": 7,
"sender_profile_sid": "<string>",
"pages": [
"<string>"
]
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": true
},
"enabled": true,
"daily_credit_limit": 2
}
'import requests
url = "https://beta.getsales.io/playtables/v1/api/plays/{sid}"
payload = {
"name": "<string>",
"audience": "<unknown>",
"action": {
"prompt": "<string>",
"per_company_limit": 13,
"workflow_sid": "<string>",
"moments": {},
"do": "<string>",
"like": { "on": True },
"comment": {
"on": True,
"brief": "<string>"
},
"per_person_weekly_cap": 7,
"sender_profile_sid": "<string>",
"pages": ["<string>"]
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": True
},
"enabled": True,
"daily_credit_limit": 2
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
audience: '<unknown>',
action: {
prompt: '<string>',
per_company_limit: 13,
workflow_sid: '<string>',
moments: {},
do: '<string>',
like: {on: true},
comment: {on: true, brief: '<string>'},
per_person_weekly_cap: 7,
sender_profile_sid: '<string>',
pages: ['<string>']
},
watch: {profile_days: 7, company_days: 30, posts_days: 1, moments: true},
enabled: true,
daily_credit_limit: 2
})
};
fetch('https://beta.getsales.io/playtables/v1/api/plays/{sid}', 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/{sid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'audience' => '<unknown>',
'action' => [
'prompt' => '<string>',
'per_company_limit' => 13,
'workflow_sid' => '<string>',
'moments' => [
],
'do' => '<string>',
'like' => [
'on' => true
],
'comment' => [
'on' => true,
'brief' => '<string>'
],
'per_person_weekly_cap' => 7,
'sender_profile_sid' => '<string>',
'pages' => [
'<string>'
]
],
'watch' => [
'profile_days' => 7,
'company_days' => 30,
'posts_days' => 1,
'moments' => true
],
'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/{sid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"audience\": \"<unknown>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"like\": {\n \"on\": true\n },\n \"comment\": {\n \"on\": true,\n \"brief\": \"<string>\"\n },\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 \"enabled\": true,\n \"daily_credit_limit\": 2\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://beta.getsales.io/playtables/v1/api/plays/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"audience\": \"<unknown>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"like\": {\n \"on\": true\n },\n \"comment\": {\n \"on\": true,\n \"brief\": \"<string>\"\n },\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 \"enabled\": true,\n \"daily_credit_limit\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/plays/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"audience\": \"<unknown>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"like\": {\n \"on\": true\n },\n \"comment\": {\n \"on\": true,\n \"brief\": \"<string>\"\n },\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 \"enabled\": true,\n \"daily_credit_limit\": 2\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "update",
"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>"
},
"updated_fields": [
"<string>"
],
"previous_values": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"kept_fields": [
"<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
Update play
Rename a play, re-aim its audience, change a find_people play’s prompt or cap, pick the workflow of a people play that waits for one (once; fixed after), change the cadence, flip the switch, set the ceiling. enabled true is the consent and makes the play due now (422 on a people play with no workflow yet); enabled false stops the next run and cancels nothing in flight; cadence manual switches it off. The sources are fixed at birth. Nothing changed is 422 nothing_to_update.
Contract:
- MCP tool
update_play, registry packagemcp.playtables/plays, mountplaytables.pipeline. - Operation
update, response envelopeupdate. - Flags: none.
PATCH
/
api
/
plays
/
{sid}
Update play
curl --request PATCH \
--url https://beta.getsales.io/playtables/v1/api/plays/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"name": "<string>",
"audience": "<unknown>",
"action": {
"prompt": "<string>",
"per_company_limit": 13,
"workflow_sid": "<string>",
"moments": {},
"do": "<string>",
"like": {
"on": true
},
"comment": {
"on": true,
"brief": "<string>"
},
"per_person_weekly_cap": 7,
"sender_profile_sid": "<string>",
"pages": [
"<string>"
]
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": true
},
"enabled": true,
"daily_credit_limit": 2
}
'import requests
url = "https://beta.getsales.io/playtables/v1/api/plays/{sid}"
payload = {
"name": "<string>",
"audience": "<unknown>",
"action": {
"prompt": "<string>",
"per_company_limit": 13,
"workflow_sid": "<string>",
"moments": {},
"do": "<string>",
"like": { "on": True },
"comment": {
"on": True,
"brief": "<string>"
},
"per_person_weekly_cap": 7,
"sender_profile_sid": "<string>",
"pages": ["<string>"]
},
"watch": {
"profile_days": 7,
"company_days": 30,
"posts_days": 1,
"moments": True
},
"enabled": True,
"daily_credit_limit": 2
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
audience: '<unknown>',
action: {
prompt: '<string>',
per_company_limit: 13,
workflow_sid: '<string>',
moments: {},
do: '<string>',
like: {on: true},
comment: {on: true, brief: '<string>'},
per_person_weekly_cap: 7,
sender_profile_sid: '<string>',
pages: ['<string>']
},
watch: {profile_days: 7, company_days: 30, posts_days: 1, moments: true},
enabled: true,
daily_credit_limit: 2
})
};
fetch('https://beta.getsales.io/playtables/v1/api/plays/{sid}', 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/{sid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'audience' => '<unknown>',
'action' => [
'prompt' => '<string>',
'per_company_limit' => 13,
'workflow_sid' => '<string>',
'moments' => [
],
'do' => '<string>',
'like' => [
'on' => true
],
'comment' => [
'on' => true,
'brief' => '<string>'
],
'per_person_weekly_cap' => 7,
'sender_profile_sid' => '<string>',
'pages' => [
'<string>'
]
],
'watch' => [
'profile_days' => 7,
'company_days' => 30,
'posts_days' => 1,
'moments' => true
],
'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/{sid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"audience\": \"<unknown>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"like\": {\n \"on\": true\n },\n \"comment\": {\n \"on\": true,\n \"brief\": \"<string>\"\n },\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 \"enabled\": true,\n \"daily_credit_limit\": 2\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://beta.getsales.io/playtables/v1/api/plays/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"audience\": \"<unknown>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"like\": {\n \"on\": true\n },\n \"comment\": {\n \"on\": true,\n \"brief\": \"<string>\"\n },\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 \"enabled\": true,\n \"daily_credit_limit\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/plays/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"audience\": \"<unknown>\",\n \"action\": {\n \"prompt\": \"<string>\",\n \"per_company_limit\": 13,\n \"workflow_sid\": \"<string>\",\n \"moments\": {},\n \"do\": \"<string>\",\n \"like\": {\n \"on\": true\n },\n \"comment\": {\n \"on\": true,\n \"brief\": \"<string>\"\n },\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 \"enabled\": true,\n \"daily_credit_limit\": 2\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "update",
"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>"
},
"updated_fields": [
"<string>"
],
"previous_values": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"kept_fields": [
"<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.
Path Parameters
Play sid (pt_pl_…).
Required string length:
18Pattern:
^pt_pl_Body
application/json
Request body of update_play.
New name of the play (1..255).
Required string length:
1 - 255A new audience, validated like at create; null = the whole tab.
A find_people play's prompt and cap, the workflow of a people play that waits for one, or a typed action's keys merged deep over the stored ones; the sources are fixed at birth.
Show child attributes
Show child attributes
The whole block, or null for nothing.
Show child attributes
Show child attributes
ask_me (the act waits for approval as a task in the Signals feed) | automatic (it goes out by itself).
Available options:
ask_me, automatic manual switches the play off.
Available options:
manual, daily The switch: true records the consent (enabled_by, enabled_at) and makes the play due now; false stops the next run, nothing in flight is cancelled.
find_people only: the credits one day may spend; null = no ceiling. 422 on an add_to_workflow play.
Required range:
x >= 1Response
update success envelope.
Available options:
true Available options:
update Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.