Update workflow

curl --request PATCH \
  --url https://beta.getsales.io/playtables/v1/api/workflows/{sid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "playtable_sid": "<string>",
  "name": "<string>",
  "description": "<string>",
  "draft_steps": [
    {
      "type": "linkedin_send_connection_request",
      "id": 2,
      "name": "<string>",
      "message": "<string>",
      "required_fields": {
        "refs": [
          "<string>"
        ]
      }
    }
  ],
  "schedule": {
    "timeblocks": [
      {
        "dow": 3,
        "start_minute": 719,
        "end_minute": 720
      }
    ],
    "timezone": "<string>",
    "use_people_timezone": true
  },
  "agent_sid": "<string>",
  "sender_profile_sids": [
    "<string>"
  ],
  "priority": 2
}
'

import requests

url = "https://beta.getsales.io/playtables/v1/api/workflows/{sid}"

payload = {
    "playtable_sid": "<string>",
    "name": "<string>",
    "description": "<string>",
    "draft_steps": [
        {
            "type": "linkedin_send_connection_request",
            "id": 2,
            "name": "<string>",
            "message": "<string>",
            "required_fields": { "refs": ["<string>"] }
        }
    ],
    "schedule": {
        "timeblocks": [
            {
                "dow": 3,
                "start_minute": 719,
                "end_minute": 720
            }
        ],
        "timezone": "<string>",
        "use_people_timezone": True
    },
    "agent_sid": "<string>",
    "sender_profile_sids": ["<string>"],
    "priority": 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({
    playtable_sid: '<string>',
    name: '<string>',
    description: '<string>',
    draft_steps: [
      {
        type: 'linkedin_send_connection_request',
        id: 2,
        name: '<string>',
        message: '<string>',
        required_fields: {refs: ['<string>']}
      }
    ],
    schedule: {
      timeblocks: [{dow: 3, start_minute: 719, end_minute: 720}],
      timezone: '<string>',
      use_people_timezone: true
    },
    agent_sid: '<string>',
    sender_profile_sids: ['<string>'],
    priority: 2
  })
};

fetch('https://beta.getsales.io/playtables/v1/api/workflows/{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/workflows/{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([
    'playtable_sid' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'draft_steps' => [
        [
                'type' => 'linkedin_send_connection_request',
                'id' => 2,
                'name' => '<string>',
                'message' => '<string>',
                'required_fields' => [
                                'refs' => [
                                                                '<string>'
                                ]
                ]
        ]
    ],
    'schedule' => [
        'timeblocks' => [
                [
                                'dow' => 3,
                                'start_minute' => 719,
                                'end_minute' => 720
                ]
        ],
        'timezone' => '<string>',
        'use_people_timezone' => true
    ],
    'agent_sid' => '<string>',
    'sender_profile_sids' => [
        '<string>'
    ],
    'priority' => 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/workflows/{sid}"

	payload := strings.NewReader("{\n  \"playtable_sid\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"draft_steps\": [\n    {\n      \"type\": \"linkedin_send_connection_request\",\n      \"id\": 2,\n      \"name\": \"<string>\",\n      \"message\": \"<string>\",\n      \"required_fields\": {\n        \"refs\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"schedule\": {\n    \"timeblocks\": [\n      {\n        \"dow\": 3,\n        \"start_minute\": 719,\n        \"end_minute\": 720\n      }\n    ],\n    \"timezone\": \"<string>\",\n    \"use_people_timezone\": true\n  },\n  \"agent_sid\": \"<string>\",\n  \"sender_profile_sids\": [\n    \"<string>\"\n  ],\n  \"priority\": 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/workflows/{sid}")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"playtable_sid\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"draft_steps\": [\n    {\n      \"type\": \"linkedin_send_connection_request\",\n      \"id\": 2,\n      \"name\": \"<string>\",\n      \"message\": \"<string>\",\n      \"required_fields\": {\n        \"refs\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"schedule\": {\n    \"timeblocks\": [\n      {\n        \"dow\": 3,\n        \"start_minute\": 719,\n        \"end_minute\": 720\n      }\n    ],\n    \"timezone\": \"<string>\",\n    \"use_people_timezone\": true\n  },\n  \"agent_sid\": \"<string>\",\n  \"sender_profile_sids\": [\n    \"<string>\"\n  ],\n  \"priority\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/playtables/v1/api/workflows/{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  \"playtable_sid\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"draft_steps\": [\n    {\n      \"type\": \"linkedin_send_connection_request\",\n      \"id\": 2,\n      \"name\": \"<string>\",\n      \"message\": \"<string>\",\n      \"required_fields\": {\n        \"refs\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"schedule\": {\n    \"timeblocks\": [\n      {\n        \"dow\": 3,\n        \"start_minute\": 719,\n        \"end_minute\": 720\n      }\n    ],\n    \"timezone\": \"<string>\",\n    \"use_people_timezone\": true\n  },\n  \"agent_sid\": \"<string>\",\n  \"sender_profile_sids\": [\n    \"<string>\"\n  ],\n  \"priority\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "update",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "draft",
    "published_version_sid": "<string>",
    "draft_steps": [
      {
        "type": "linkedin_send_connection_request",
        "id": 2,
        "name": "<string>",
        "message": "<string>",
        "required_fields": {
          "refs": [
            "<string>"
          ],
          "on_missing": "fail"
        }
      }
    ],
    "schedule": {
      "timeblocks": [
        {
          "dow": 3,
          "start_minute": 719,
          "end_minute": 720
        }
      ],
      "timezone": "<string>",
      "use_people_timezone": true
    },
    "on_reply": "autopilot",
    "agent_sid": "<string>",
    "sender_profile_sids": [
      "<string>"
    ],
    "rotation_strategy": "fair",
    "priority": 123,
    "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>"
  },
  "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>"
  }
}

workflows

Update workflow

Draft-editing verb (partial update). draft_steps is FULL-REPLACE: send the whole array, CARRY the id of every kept step verbatim, OMIT ids on new steps - the response echoes all ids filled. Config edits (sender pool, schedule, on_reply, rotation_strategy, priority) affect FUTURE decisions only; pinned records keep their sender. status = archive family ONLY (archived / paused / draft); anything involving active → 422 - use pause/resume. Archived rows reject other edits.

Contract:

MCP tool update_workflow, registry package mcp.playtables/workflows, mount playtables.workflows.
Operation update, response envelope update.
Flags: none.

PATCH

api

workflows

{sid}

Update workflow

curl --request PATCH \
  --url https://beta.getsales.io/playtables/v1/api/workflows/{sid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "playtable_sid": "<string>",
  "name": "<string>",
  "description": "<string>",
  "draft_steps": [
    {
      "type": "linkedin_send_connection_request",
      "id": 2,
      "name": "<string>",
      "message": "<string>",
      "required_fields": {
        "refs": [
          "<string>"
        ]
      }
    }
  ],
  "schedule": {
    "timeblocks": [
      {
        "dow": 3,
        "start_minute": 719,
        "end_minute": 720
      }
    ],
    "timezone": "<string>",
    "use_people_timezone": true
  },
  "agent_sid": "<string>",
  "sender_profile_sids": [
    "<string>"
  ],
  "priority": 2
}
'

import requests

url = "https://beta.getsales.io/playtables/v1/api/workflows/{sid}"

payload = {
    "playtable_sid": "<string>",
    "name": "<string>",
    "description": "<string>",
    "draft_steps": [
        {
            "type": "linkedin_send_connection_request",
            "id": 2,
            "name": "<string>",
            "message": "<string>",
            "required_fields": { "refs": ["<string>"] }
        }
    ],
    "schedule": {
        "timeblocks": [
            {
                "dow": 3,
                "start_minute": 719,
                "end_minute": 720
            }
        ],
        "timezone": "<string>",
        "use_people_timezone": True
    },
    "agent_sid": "<string>",
    "sender_profile_sids": ["<string>"],
    "priority": 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({
    playtable_sid: '<string>',
    name: '<string>',
    description: '<string>',
    draft_steps: [
      {
        type: 'linkedin_send_connection_request',
        id: 2,
        name: '<string>',
        message: '<string>',
        required_fields: {refs: ['<string>']}
      }
    ],
    schedule: {
      timeblocks: [{dow: 3, start_minute: 719, end_minute: 720}],
      timezone: '<string>',
      use_people_timezone: true
    },
    agent_sid: '<string>',
    sender_profile_sids: ['<string>'],
    priority: 2
  })
};

fetch('https://beta.getsales.io/playtables/v1/api/workflows/{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/workflows/{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([
    'playtable_sid' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'draft_steps' => [
        [
                'type' => 'linkedin_send_connection_request',
                'id' => 2,
                'name' => '<string>',
                'message' => '<string>',
                'required_fields' => [
                                'refs' => [
                                                                '<string>'
                                ]
                ]
        ]
    ],
    'schedule' => [
        'timeblocks' => [
                [
                                'dow' => 3,
                                'start_minute' => 719,
                                'end_minute' => 720
                ]
        ],
        'timezone' => '<string>',
        'use_people_timezone' => true
    ],
    'agent_sid' => '<string>',
    'sender_profile_sids' => [
        '<string>'
    ],
    'priority' => 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/workflows/{sid}"

	payload := strings.NewReader("{\n  \"playtable_sid\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"draft_steps\": [\n    {\n      \"type\": \"linkedin_send_connection_request\",\n      \"id\": 2,\n      \"name\": \"<string>\",\n      \"message\": \"<string>\",\n      \"required_fields\": {\n        \"refs\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"schedule\": {\n    \"timeblocks\": [\n      {\n        \"dow\": 3,\n        \"start_minute\": 719,\n        \"end_minute\": 720\n      }\n    ],\n    \"timezone\": \"<string>\",\n    \"use_people_timezone\": true\n  },\n  \"agent_sid\": \"<string>\",\n  \"sender_profile_sids\": [\n    \"<string>\"\n  ],\n  \"priority\": 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/workflows/{sid}")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"playtable_sid\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"draft_steps\": [\n    {\n      \"type\": \"linkedin_send_connection_request\",\n      \"id\": 2,\n      \"name\": \"<string>\",\n      \"message\": \"<string>\",\n      \"required_fields\": {\n        \"refs\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"schedule\": {\n    \"timeblocks\": [\n      {\n        \"dow\": 3,\n        \"start_minute\": 719,\n        \"end_minute\": 720\n      }\n    ],\n    \"timezone\": \"<string>\",\n    \"use_people_timezone\": true\n  },\n  \"agent_sid\": \"<string>\",\n  \"sender_profile_sids\": [\n    \"<string>\"\n  ],\n  \"priority\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/playtables/v1/api/workflows/{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  \"playtable_sid\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"draft_steps\": [\n    {\n      \"type\": \"linkedin_send_connection_request\",\n      \"id\": 2,\n      \"name\": \"<string>\",\n      \"message\": \"<string>\",\n      \"required_fields\": {\n        \"refs\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"schedule\": {\n    \"timeblocks\": [\n      {\n        \"dow\": 3,\n        \"start_minute\": 719,\n        \"end_minute\": 720\n      }\n    ],\n    \"timezone\": \"<string>\",\n    \"use_people_timezone\": true\n  },\n  \"agent_sid\": \"<string>\",\n  \"sender_profile_sids\": [\n    \"<string>\"\n  ],\n  \"priority\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "update",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "draft",
    "published_version_sid": "<string>",
    "draft_steps": [
      {
        "type": "linkedin_send_connection_request",
        "id": 2,
        "name": "<string>",
        "message": "<string>",
        "required_fields": {
          "refs": [
            "<string>"
          ],
          "on_missing": "fail"
        }
      }
    ],
    "schedule": {
      "timeblocks": [
        {
          "dow": 3,
          "start_minute": 719,
          "end_minute": 720
        }
      ],
      "timezone": "<string>",
      "use_people_timezone": true
    },
    "on_reply": "autopilot",
    "agent_sid": "<string>",
    "sender_profile_sids": [
      "<string>"
    ],
    "rotation_strategy": "fair",
    "priority": 123,
    "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>"
  },
  "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

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.

Path Parameters

sid

string

required

Workflow sid (wf_wf_…).

Required string length: 18

Pattern: ^wf_wf_

Body

application/json

Request body of update_workflow.

playtable_sid

string

Move the workflow to another home playtable (draft only; the sources and step references must still resolve at publish).

Required string length: 18

Pattern: ^pt_tb_

name

string

New campaign name (1..255), unique per team.

Required string length: 1 - 255

description

string | null

null resets the description.

Maximum string length: 2000

draft_steps

object[]

FULL-REPLACE of the working copy. Carry ids of kept steps verbatim; omit ids on new steps (assigned from step_id_seq). Dropping the id of an unchanged step risks a possible_lost_identity warning.

Show child attributes

schedule

object | null

Full-replace; null clears the windows (any time).

Show child attributes

on_reply

enum<string>

Applies to the next replies and to the threads the workflow acts on from now on; a thread already stamped keeps its automation mode until the next report.

Available options:

autopilot,

copilot,

stop,

continue

agent_sid

string | null

Pick the AI SDR for the threads this workflow starts (ub_ag_…); null = back to its table's pick. Reaches the open threads it started at their next turn.

Required string length: 18

Pattern: ^ub_ag_

sender_profile_sids

string[]

Full-replace of the pool (existence-checked); already-pinned records keep their sender.

Required string length: 18

Pattern: ^ub_sp_

rotation_strategy

enum<string>

Applies to future enrollments only.

Available options:

fair,

random,

new_sender,

prior_engagement

priority

integer

New share of a shared sender profile: 1..3 (low / medium / high), never a rank.

Required range: 1 <= x <= 3

status

enum<string>

Archive family only: archived (from draft|paused); paused = unarchive (requires a published version); draft = unarchive (if never published). Transitions involving active → 422 invalid_transition (use pause/resume).

Available options:

archived,

paused,

draft

Response

update success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

update

item

object

required

Show child attributes

updated_fields

string[]

required

previous_values

object

required

Show child attributes

Overview

Playtables API

Unibox API

Signals API

Integrations API

ID and Teams API

Update workflow

Authorizations

Path Parameters

Body

Response