Skip to main content
PATCH
Change, activate, stop or archive a digital worker

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

worker_id
string
required

The worker's id, from GET /v1/digital_workers

Body

application/json
accounts
Accounts · object
assignment
Assignment · object
autonomy
Autonomy · object
channels
Channels · object
description
string | null

Its job, in plain words: every conversation it has opens with this

Maximum string length: 10000
if_unchanged_since
string<date-time>

The worker's updated_at as you read it. If the worker was saved after that, a 409 and nothing is written: read it again and try your change on it again

knowledge_base_ids
string[]

The knowledge bases it searches when it answers, by id from GET /v1/knowledge_bases: replaced whole, [] clears them

Maximum array length: 100
name
string
Required string length: 1 - 255
persona
Persona · object
skill_keys
string[]

The skills it can use, by key from GET /v1/skills: replaced whole, [] clears them. A skill added must be one that list holds, and must not run in a sub-agent, which a worker never starts

Maximum array length: 50
Required string length: 1 - 255
status
enum<string>

draft, active or archived. Only an active worker answers or writes to customers; a draft or archived one answers nobody

Available options:
draft,
active,
archived
version_label
string | null

A label for the version this save adds, shown in the app's Versions tab. Blank is none

Maximum string length: 200

Response

200 - application/json

Successful Response

accounts
Accounts · object
required
assignment
Assignment · object
required
autonomy
Autonomy · object
required

Whether its replies wait for a person

avatar_url
string | null
required
built_in
boolean
required

Whether it is the workspace's own worker, which Statisfy set up

channels
Channels · object
required

Where it answers customers

created_at
string
required

ISO 8601 UTC

description
string | null
required

Its job, in plain words: every conversation it has opens with this

id
string
required
kind
enum<string>
required

customer_success or support: a support worker answers customers' questions; any other is customer_success

Available options:
customer_success,
support
knowledge_bases
KnowledgeBaseRef · object[]
required

The knowledge bases it searches when it answers, in the order they were set

name
string
required
outreach_enabled
boolean
required

Whether it does its proactive tasks (GET /v1/digital_workers/{worker_id}/tasks): they run while this is on and the worker isn't archived. It is switched in the app

persona
Persona · object
required
skills
WorkerSkill · object[]
required

The skills it can use when it answers, in the order they were set

status
enum<string>
required

draft, active or archived. Only an active worker answers or writes to customers; a draft or archived one answers nobody

Available options:
draft,
active,
archived
updated_at
string
required

ISO 8601 UTC