Skip to main content
PUT
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

flowId
string<uuid>
required

Body

application/json

Fields to change on a customer flow. The step graph is edited through PUT /steps instead.

title
string
Minimum string length: 1
description
string | null
scriptedBranchingMode
enum<string>
Available options:
DETERMINISTIC,
ADAPTIVE
agentIds
string<uuid>[]

Replaces the linked agents. Omit to leave them unchanged.

Minimum array length: 1
agentExpectations
object[]

Replaces the flow-level expectations. Omit to leave them unchanged.

Response

The updated customer flow

data
object
required

A customer flow: the conversation a simulated customer has with the agent under test. Flows with source SYSTEM are curated by Roark, shared across projects, and read-only.