Skip to main content
PATCH
Update agent plan

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

Agent plan sid (ub_pl_…).

Required string length: 18
Pattern: ^ub_pl_

Body

application/json

Request body of update_agent_plan.

state
enum<string>

active approves a proposed plan (stamps approved_by_user_sid, releases the parked steps and arms the first one); canceled stops it and hands the thread back. Nothing else is accepted: completed and superseded are system-owned and rejected.

Available options:
active,
canceled
steps
object[]

Replaces the NON-TERMINAL tail of the plan, 1 to 8 entries. Done, skipped or failed steps stay untouched and may not appear; waits re-arm on the new values. Allowed while proposed or active. Leaving out a follow-up and its reply wait skips that follow-up.

Required array length: 1 - 8 elements
end_wait
boolean

true: the wait the active plan is counting down ends now, so what follows goes at once, through the follow-up caps a wait that ran out meets. 409 no_wait_to_end when the next step is not a wait counting down. Runs after the other fields.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.