Stop playtable runs
curl --request POST \
--url https://api2.getsales.io/playtables/v1/api/playtable-runs/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"run_sid": "<string>",
"field_sid": "<string>",
"playtable_sid": "<string>",
"dry_run": true
}
'import requests
url = "https://api2.getsales.io/playtables/v1/api/playtable-runs/cancel"
payload = {
"run_sid": "<string>",
"field_sid": "<string>",
"playtable_sid": "<string>",
"dry_run": 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({
run_sid: '<string>',
field_sid: '<string>',
playtable_sid: '<string>',
dry_run: true
})
};
fetch('https://api2.getsales.io/playtables/v1/api/playtable-runs/cancel', 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://api2.getsales.io/playtables/v1/api/playtable-runs/cancel",
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([
'run_sid' => '<string>',
'field_sid' => '<string>',
'playtable_sid' => '<string>',
'dry_run' => 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://api2.getsales.io/playtables/v1/api/playtable-runs/cancel"
payload := strings.NewReader("{\n \"run_sid\": \"<string>\",\n \"field_sid\": \"<string>\",\n \"playtable_sid\": \"<string>\",\n \"dry_run\": 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://api2.getsales.io/playtables/v1/api/playtable-runs/cancel")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"run_sid\": \"<string>\",\n \"field_sid\": \"<string>\",\n \"playtable_sid\": \"<string>\",\n \"dry_run\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api2.getsales.io/playtables/v1/api/playtable-runs/cancel")
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 \"run_sid\": \"<string>\",\n \"field_sid\": \"<string>\",\n \"playtable_sid\": \"<string>\",\n \"dry_run\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": "<unknown>",
"result": {
"dry_run": true,
"runs": [
{
"sid": "<string>",
"waiting": true,
"reverted_cells_count": 1,
"in_flight_cells_count": 1
}
],
"cancelled_count": 1,
"reverted_cells_count": 1,
"in_flight_cells_count": 1,
"spent_credits": 123,
"backlog_cells_count": 1,
"auto_run_off_field_sids": [
"<string>"
]
},
"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_runs
Stop playtable runs
Stop runs, one scope: run_sid (one run), field_sid (the column: its unfinished runs and its queue) or playtable_sid (every run and action column of the table). Queued cells go back, and so do the companies a Find people column still has waiting in its search; cells a worker holds finish, charged; no refunds. A column or table Stop turns config.auto_run off (auto_run_off_field_sids). The first call stops nothing: tell the user its preview_result and that auto-run goes off, then confirm.
Contract:
- MCP tool
cancel_playtable_runs, registry packagemcp.playtables/playtable_runs, mountplaytables.columns. - Operation
action, response envelopeaction. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
POST
/
api
/
playtable-runs
/
cancel
Stop playtable runs
curl --request POST \
--url https://api2.getsales.io/playtables/v1/api/playtable-runs/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"run_sid": "<string>",
"field_sid": "<string>",
"playtable_sid": "<string>",
"dry_run": true
}
'import requests
url = "https://api2.getsales.io/playtables/v1/api/playtable-runs/cancel"
payload = {
"run_sid": "<string>",
"field_sid": "<string>",
"playtable_sid": "<string>",
"dry_run": 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({
run_sid: '<string>',
field_sid: '<string>',
playtable_sid: '<string>',
dry_run: true
})
};
fetch('https://api2.getsales.io/playtables/v1/api/playtable-runs/cancel', 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://api2.getsales.io/playtables/v1/api/playtable-runs/cancel",
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([
'run_sid' => '<string>',
'field_sid' => '<string>',
'playtable_sid' => '<string>',
'dry_run' => 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://api2.getsales.io/playtables/v1/api/playtable-runs/cancel"
payload := strings.NewReader("{\n \"run_sid\": \"<string>\",\n \"field_sid\": \"<string>\",\n \"playtable_sid\": \"<string>\",\n \"dry_run\": 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://api2.getsales.io/playtables/v1/api/playtable-runs/cancel")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"run_sid\": \"<string>\",\n \"field_sid\": \"<string>\",\n \"playtable_sid\": \"<string>\",\n \"dry_run\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api2.getsales.io/playtables/v1/api/playtable-runs/cancel")
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 \"run_sid\": \"<string>\",\n \"field_sid\": \"<string>\",\n \"playtable_sid\": \"<string>\",\n \"dry_run\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": "<unknown>",
"result": {
"dry_run": true,
"runs": [
{
"sid": "<string>",
"waiting": true,
"reverted_cells_count": 1,
"in_flight_cells_count": 1
}
],
"cancelled_count": 1,
"reverted_cells_count": 1,
"in_flight_cells_count": 1,
"spent_credits": 123,
"backlog_cells_count": 1,
"auto_run_off_field_sids": [
"<string>"
]
},
"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
Body
application/json
Request body of cancel_playtable_runs.