Skip to main content
PATCH
Change or close a proactive task

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

task_id
string
required

The task's id, from GET /v1/digital_workers/{worker_id}/tasks

Body

application/json
conditions
Conditions · object | null

Narrows a book task to the accounts that match: the conditions of an account segment, as in the worker's accounts.segment. Null means the whole book. Book tasks only

deadline
string<date-time> | null

A goal's deadline (ISO 8601; one without an offset is UTC): once it passes, the worker stops checking the goal and its status becomes needs_recheck. Goals only; null clears it

instructions
string

What the worker should do: added to its prompt every time the task runs

Required string length: 1 - 10000
schedule
CronSchedule · object

When a recurring task runs, in UTC: a cron expression, or daily or weekly at an hour. Recurring tasks only

status
enum<string>

open runs when due; done never runs again; needs_recheck is a goal the worker reported blocked, or whose deadline passed, for a person to look at

Available options:
open,
done,
needs_recheck

Response

200 - application/json

Successful Response

account_id
string | null
required

The account an account task is about

account_name
string | null
required

That account's name; null once it no longer exists

conditions
Conditions · object | null
required

Narrows a book task to the accounts that match: the conditions of an account segment, as in the worker's accounts.segment. Null means the whole book

created_at
string
required

ISO 8601 UTC

deadline
string | null
required

A goal's deadline, ISO 8601 UTC

id
string
required
instructions
string
required

What the worker should do: added to its prompt every time the task runs

kind
enum<string>
required

one_off runs once, then is done; recurring runs on its schedule; goal is checked each time the worker runs while it is open, until the worker reports it achieved or blocked or its deadline passes

Available options:
one_off,
recurring,
goal
next_run_at
string | null
required

When it is next due, ISO 8601 UTC; null when it is due whenever the worker next runs. It runs only while the worker's outreach_enabled is on

parked_at
string | null
required

Since when, ISO 8601 UTC

parked_reason
string | null
required

Why the worker isn't running it, such as a schedule or conditions that need repair, or a wait for its outreach budget; null when nothing holds it

schedule
Schedule · object | null
required

When a recurring task runs, in UTC: a cron expression, or daily or weekly at an hour

scope
enum<string>
required

global is about your workspace and no one account; account is about the account in account_id; book is about each account the worker covers (its accounts.segment), once each period, narrowed by conditions

Available options:
global,
account,
book
source
enum<string>
required

Who added it: human (a person, or a key), self (the worker, as a follow-up) or system (Statisfy: a default task, which you may change, or delete to opt out of it)

Available options:
human,
self,
system
status
enum<string>
required

open runs when due; done never runs again; needs_recheck is a goal the worker reported blocked, or whose deadline passed, for a person to look at

Available options:
open,
done,
needs_recheck
updated_at
string
required

ISO 8601 UTC

worker_id
string
required