curl --request PATCH \
--url https://api.statisfy.com/v1/digital_workers/{worker_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accounts": null,
"assignment": null,
"autonomy": null,
"channels": null,
"description": "<string>",
"if_unchanged_since": null,
"knowledge_base_ids": null,
"name": null,
"persona": null,
"skill_keys": null,
"status": null,
"version_label": "<string>"
}
'import requests
url = "https://api.statisfy.com/v1/digital_workers/{worker_id}"
payload = {
"accounts": None,
"assignment": None,
"autonomy": None,
"channels": None,
"description": "<string>",
"if_unchanged_since": None,
"knowledge_base_ids": None,
"name": None,
"persona": None,
"skill_keys": None,
"status": None,
"version_label": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accounts: null,
assignment: null,
autonomy: null,
channels: null,
description: '<string>',
if_unchanged_since: null,
knowledge_base_ids: null,
name: null,
persona: null,
skill_keys: null,
status: null,
version_label: '<string>'
})
};
fetch('https://api.statisfy.com/v1/digital_workers/{worker_id}', 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://api.statisfy.com/v1/digital_workers/{worker_id}",
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([
'accounts' => null,
'assignment' => null,
'autonomy' => null,
'channels' => null,
'description' => '<string>',
'if_unchanged_since' => null,
'knowledge_base_ids' => null,
'name' => null,
'persona' => null,
'skill_keys' => null,
'status' => null,
'version_label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.statisfy.com/v1/digital_workers/{worker_id}"
payload := strings.NewReader("{\n \"accounts\": null,\n \"assignment\": null,\n \"autonomy\": null,\n \"channels\": null,\n \"description\": \"<string>\",\n \"if_unchanged_since\": null,\n \"knowledge_base_ids\": null,\n \"name\": null,\n \"persona\": null,\n \"skill_keys\": null,\n \"status\": null,\n \"version_label\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.statisfy.com/v1/digital_workers/{worker_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accounts\": null,\n \"assignment\": null,\n \"autonomy\": null,\n \"channels\": null,\n \"description\": \"<string>\",\n \"if_unchanged_since\": null,\n \"knowledge_base_ids\": null,\n \"name\": null,\n \"persona\": null,\n \"skill_keys\": null,\n \"status\": null,\n \"version_label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/digital_workers/{worker_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accounts\": null,\n \"assignment\": null,\n \"autonomy\": null,\n \"channels\": null,\n \"description\": \"<string>\",\n \"if_unchanged_since\": null,\n \"knowledge_base_ids\": null,\n \"name\": null,\n \"persona\": null,\n \"skill_keys\": null,\n \"status\": null,\n \"version_label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"accounts": {
"segment": {}
},
"assignment": {
"owner_field": "<string>",
"people": [
"<string>"
],
"strategy": "smart",
"to": "account_owner",
"when_teammate_answers": "keep_owner"
},
"autonomy": {
"channels": {},
"default": "auto"
},
"avatar_url": "<string>",
"built_in": true,
"channels": {
"email": {
"acknowledge": true,
"acknowledgement": "<string>",
"addresses": [
"<string>"
],
"company_address": "<string>",
"enabled": true,
"forwarding": true,
"shared_mailboxes": [
"<string>"
],
"take_in_unknown_senders": true,
"watch_mailboxes": true
},
"in_app_sdk": {
"acknowledgement": "<string>",
"enabled": true
},
"portal": {
"acknowledgement": "<string>",
"enabled": true
},
"slack": {
"acknowledge": true,
"acknowledgement": "<string>",
"enabled": true,
"grouping": "thread"
},
"teams": {
"acknowledge": true,
"acknowledgement": "<string>",
"enabled": true
}
},
"created_at": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "customer_success",
"knowledge_bases": [
{
"id": "<string>",
"name": "<string>"
}
],
"name": "<string>",
"outreach_enabled": true,
"persona": {
"ai_disclosure": "transparent",
"greeting": "<string>",
"guardrails": "<string>",
"voice": "<string>"
},
"skills": [
{
"enabled": true,
"key": "<string>",
"name": "<string>"
}
],
"status": "draft",
"updated_at": "<string>"
}Change, activate, stop or archive a digital worker
Changes what you send of a worker’s settings; each part keeps what it leaves out. status activates it (active), stops it (draft) or archives it. knowledge_base_ids sets the knowledge bases it searches, and skill_keys the skills it can use, each the whole list. Activating a worker, or changing an active one, needs digital_workers:activate too; stopping or archiving it doesn’t. An active worker needs accounts, an assignment that reaches a person, and an acknowledgement for each enabled channel that sends one: a 422 lists what’s missing. If the worker changes while yours is being checked, or another activation in your workspace keeps it waiting too long, a 409 asks you to read it again and send the change again.
curl --request PATCH \
--url https://api.statisfy.com/v1/digital_workers/{worker_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accounts": null,
"assignment": null,
"autonomy": null,
"channels": null,
"description": "<string>",
"if_unchanged_since": null,
"knowledge_base_ids": null,
"name": null,
"persona": null,
"skill_keys": null,
"status": null,
"version_label": "<string>"
}
'import requests
url = "https://api.statisfy.com/v1/digital_workers/{worker_id}"
payload = {
"accounts": None,
"assignment": None,
"autonomy": None,
"channels": None,
"description": "<string>",
"if_unchanged_since": None,
"knowledge_base_ids": None,
"name": None,
"persona": None,
"skill_keys": None,
"status": None,
"version_label": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accounts: null,
assignment: null,
autonomy: null,
channels: null,
description: '<string>',
if_unchanged_since: null,
knowledge_base_ids: null,
name: null,
persona: null,
skill_keys: null,
status: null,
version_label: '<string>'
})
};
fetch('https://api.statisfy.com/v1/digital_workers/{worker_id}', 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://api.statisfy.com/v1/digital_workers/{worker_id}",
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([
'accounts' => null,
'assignment' => null,
'autonomy' => null,
'channels' => null,
'description' => '<string>',
'if_unchanged_since' => null,
'knowledge_base_ids' => null,
'name' => null,
'persona' => null,
'skill_keys' => null,
'status' => null,
'version_label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.statisfy.com/v1/digital_workers/{worker_id}"
payload := strings.NewReader("{\n \"accounts\": null,\n \"assignment\": null,\n \"autonomy\": null,\n \"channels\": null,\n \"description\": \"<string>\",\n \"if_unchanged_since\": null,\n \"knowledge_base_ids\": null,\n \"name\": null,\n \"persona\": null,\n \"skill_keys\": null,\n \"status\": null,\n \"version_label\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.statisfy.com/v1/digital_workers/{worker_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accounts\": null,\n \"assignment\": null,\n \"autonomy\": null,\n \"channels\": null,\n \"description\": \"<string>\",\n \"if_unchanged_since\": null,\n \"knowledge_base_ids\": null,\n \"name\": null,\n \"persona\": null,\n \"skill_keys\": null,\n \"status\": null,\n \"version_label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/digital_workers/{worker_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accounts\": null,\n \"assignment\": null,\n \"autonomy\": null,\n \"channels\": null,\n \"description\": \"<string>\",\n \"if_unchanged_since\": null,\n \"knowledge_base_ids\": null,\n \"name\": null,\n \"persona\": null,\n \"skill_keys\": null,\n \"status\": null,\n \"version_label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"accounts": {
"segment": {}
},
"assignment": {
"owner_field": "<string>",
"people": [
"<string>"
],
"strategy": "smart",
"to": "account_owner",
"when_teammate_answers": "keep_owner"
},
"autonomy": {
"channels": {},
"default": "auto"
},
"avatar_url": "<string>",
"built_in": true,
"channels": {
"email": {
"acknowledge": true,
"acknowledgement": "<string>",
"addresses": [
"<string>"
],
"company_address": "<string>",
"enabled": true,
"forwarding": true,
"shared_mailboxes": [
"<string>"
],
"take_in_unknown_senders": true,
"watch_mailboxes": true
},
"in_app_sdk": {
"acknowledgement": "<string>",
"enabled": true
},
"portal": {
"acknowledgement": "<string>",
"enabled": true
},
"slack": {
"acknowledge": true,
"acknowledgement": "<string>",
"enabled": true,
"grouping": "thread"
},
"teams": {
"acknowledge": true,
"acknowledgement": "<string>",
"enabled": true
}
},
"created_at": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "customer_success",
"knowledge_bases": [
{
"id": "<string>",
"name": "<string>"
}
],
"name": "<string>",
"outreach_enabled": true,
"persona": {
"ai_disclosure": "transparent",
"greeting": "<string>",
"guardrails": "<string>",
"voice": "<string>"
},
"skills": [
{
"enabled": true,
"key": "<string>",
"name": "<string>"
}
],
"status": "draft",
"updated_at": "<string>"
}Authorizations
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Body
Response
Successful Response
Was this page helpful?