Update a customer flow

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const customerFlow = await client.customerFlow.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(customerFlow.data);

import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
customer_flow = client.customer_flow.update(
    flow_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(customer_flow.data)

curl --request PUT \
  --url https://api.roark.ai/v1/customer-flow/{flowId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "agentIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "agentExpectations": [
    {
      "prompt": "The agent confirmed the new appointment time back to the customer"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/customer-flow/{flowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'agentIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'agentExpectations' => [
        [
                'prompt' => 'The agent confirmed the new appointment time back to the customer'
        ]
    ]
  ]),
  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.roark.ai/v1/customer-flow/{flowId}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"agentIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"agentExpectations\": [\n    {\n      \"prompt\": \"The agent confirmed the new appointment time back to the customer\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.roark.ai/v1/customer-flow/{flowId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"agentIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"agentExpectations\": [\n    {\n      \"prompt\": \"The agent confirmed the new appointment time back to the customer\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/customer-flow/{flowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"agentIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"agentExpectations\": [\n    {\n      \"prompt\": \"The agent confirmed the new appointment time back to the customer\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "source": "CUSTOM",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "agents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "customId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "agentExpectations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "prompt": "<string>"
      }
    ],
    "type": "SCRIPTED",
    "branchingMode": "DETERMINISTIC",
    "happyPath": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "precededByCustomerFlowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "precededByCustomerFlowVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isGenerated": false,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "personaOverride": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "language": "EN",
        "understoodLanguages": [
          "EN"
        ],
        "accent": "US",
        "age": "ADULT",
        "gender": "MALE",
        "backgroundNoise": "NONE",
        "speechPace": "NORMAL",
        "speechClarity": "CLEAR",
        "hasDisfluencies": false,
        "baseEmotion": "NEUTRAL",
        "intentClarity": "CLEAR",
        "confirmationStyle": "EXPLICIT",
        "memoryReliability": "HIGH",
        "responseTiming": "NORMAL",
        "idleMessages": [
          "<string>"
        ],
        "idleTimeoutSeconds": 10,
        "idleMessageMaxSpokenCount": 3,
        "idleMessageResetCountOnUserSpeechEnabled": true,
        "properties": {
          "age": 35,
          "zipCode": "94105",
          "occupation": "Software Engineer"
        },
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "description": "<string>",
        "secondaryLanguage": "EN",
        "backstoryPrompt": "A busy professional calling during lunch break"
      },
      "environment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "backgroundNoise": "NONE",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "description": "<string>"
      },
      "additionalExpectations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>"
        }
      ],
      "type": "SCRIPTED",
      "steps": [
        {
          "type": "AGENT_TURN",
          "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "ref": "<string>",
          "steps": "<array>",
          "mergeIntoNodeIds": [
            "<string>"
          ],
          "content": "<string>"
        }
      ]
    },
    "edgeCases": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "precededByCustomerFlowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "precededByCustomerFlowVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "isGenerated": false,
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "personaOverride": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "language": "EN",
          "understoodLanguages": [
            "EN"
          ],
          "accent": "US",
          "age": "ADULT",
          "gender": "MALE",
          "backgroundNoise": "NONE",
          "speechPace": "NORMAL",
          "speechClarity": "CLEAR",
          "hasDisfluencies": false,
          "baseEmotion": "NEUTRAL",
          "intentClarity": "CLEAR",
          "confirmationStyle": "EXPLICIT",
          "memoryReliability": "HIGH",
          "responseTiming": "NORMAL",
          "idleMessages": [
            "<string>"
          ],
          "idleTimeoutSeconds": 10,
          "idleMessageMaxSpokenCount": 3,
          "idleMessageResetCountOnUserSpeechEnabled": true,
          "properties": {
            "age": 35,
            "zipCode": "94105",
            "occupation": "Software Engineer"
          },
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "description": "<string>",
          "secondaryLanguage": "EN",
          "backstoryPrompt": "A busy professional calling during lunch break"
        },
        "environment": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "backgroundNoise": "NONE",
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "description": "<string>"
        },
        "additionalExpectations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "prompt": "<string>"
          }
        ],
        "type": "SCRIPTED",
        "steps": [
          {
            "type": "AGENT_TURN",
            "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "ref": "<string>",
            "steps": "<array>",
            "mergeIntoNodeIds": [
              "<string>"
            ],
            "content": "<string>"
          }
        ]
      }
    ],
    "description": "<string>",
    "graph": [
      {
        "type": "AGENT_TURN",
        "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ref": "<string>",
        "steps": "<array>",
        "mergeIntoNodeIds": [
          "<string>"
        ],
        "content": "<string>"
      }
    ]
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}

{
  "type": "forbidden",
  "code": "permission_denied",
  "message": "You do not have permission to access this resource"
}

{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}

{
  "type": "rate_limit",
  "code": "too_many_requests",
  "message": "Rate limit exceeded"
}

{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

PUT

customer-flow

{flowId}

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const customerFlow = await client.customerFlow.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(customerFlow.data);

import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
customer_flow = client.customer_flow.update(
    flow_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(customer_flow.data)

curl --request PUT \
  --url https://api.roark.ai/v1/customer-flow/{flowId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "agentIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "agentExpectations": [
    {
      "prompt": "The agent confirmed the new appointment time back to the customer"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/customer-flow/{flowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'agentIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'agentExpectations' => [
        [
                'prompt' => 'The agent confirmed the new appointment time back to the customer'
        ]
    ]
  ]),
  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.roark.ai/v1/customer-flow/{flowId}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"agentIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"agentExpectations\": [\n    {\n      \"prompt\": \"The agent confirmed the new appointment time back to the customer\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.roark.ai/v1/customer-flow/{flowId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"agentIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"agentExpectations\": [\n    {\n      \"prompt\": \"The agent confirmed the new appointment time back to the customer\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/customer-flow/{flowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"agentIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"agentExpectations\": [\n    {\n      \"prompt\": \"The agent confirmed the new appointment time back to the customer\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "source": "CUSTOM",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "agents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "customId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "agentExpectations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "prompt": "<string>"
      }
    ],
    "type": "SCRIPTED",
    "branchingMode": "DETERMINISTIC",
    "happyPath": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "precededByCustomerFlowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "precededByCustomerFlowVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isGenerated": false,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "personaOverride": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "language": "EN",
        "understoodLanguages": [
          "EN"
        ],
        "accent": "US",
        "age": "ADULT",
        "gender": "MALE",
        "backgroundNoise": "NONE",
        "speechPace": "NORMAL",
        "speechClarity": "CLEAR",
        "hasDisfluencies": false,
        "baseEmotion": "NEUTRAL",
        "intentClarity": "CLEAR",
        "confirmationStyle": "EXPLICIT",
        "memoryReliability": "HIGH",
        "responseTiming": "NORMAL",
        "idleMessages": [
          "<string>"
        ],
        "idleTimeoutSeconds": 10,
        "idleMessageMaxSpokenCount": 3,
        "idleMessageResetCountOnUserSpeechEnabled": true,
        "properties": {
          "age": 35,
          "zipCode": "94105",
          "occupation": "Software Engineer"
        },
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "description": "<string>",
        "secondaryLanguage": "EN",
        "backstoryPrompt": "A busy professional calling during lunch break"
      },
      "environment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "backgroundNoise": "NONE",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "description": "<string>"
      },
      "additionalExpectations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>"
        }
      ],
      "type": "SCRIPTED",
      "steps": [
        {
          "type": "AGENT_TURN",
          "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "ref": "<string>",
          "steps": "<array>",
          "mergeIntoNodeIds": [
            "<string>"
          ],
          "content": "<string>"
        }
      ]
    },
    "edgeCases": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "precededByCustomerFlowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "precededByCustomerFlowVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "isGenerated": false,
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "personaOverride": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "language": "EN",
          "understoodLanguages": [
            "EN"
          ],
          "accent": "US",
          "age": "ADULT",
          "gender": "MALE",
          "backgroundNoise": "NONE",
          "speechPace": "NORMAL",
          "speechClarity": "CLEAR",
          "hasDisfluencies": false,
          "baseEmotion": "NEUTRAL",
          "intentClarity": "CLEAR",
          "confirmationStyle": "EXPLICIT",
          "memoryReliability": "HIGH",
          "responseTiming": "NORMAL",
          "idleMessages": [
            "<string>"
          ],
          "idleTimeoutSeconds": 10,
          "idleMessageMaxSpokenCount": 3,
          "idleMessageResetCountOnUserSpeechEnabled": true,
          "properties": {
            "age": 35,
            "zipCode": "94105",
            "occupation": "Software Engineer"
          },
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "description": "<string>",
          "secondaryLanguage": "EN",
          "backstoryPrompt": "A busy professional calling during lunch break"
        },
        "environment": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "backgroundNoise": "NONE",
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "description": "<string>"
        },
        "additionalExpectations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "prompt": "<string>"
          }
        ],
        "type": "SCRIPTED",
        "steps": [
          {
            "type": "AGENT_TURN",
            "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "ref": "<string>",
            "steps": "<array>",
            "mergeIntoNodeIds": [
              "<string>"
            ],
            "content": "<string>"
          }
        ]
      }
    ],
    "description": "<string>",
    "graph": [
      {
        "type": "AGENT_TURN",
        "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ref": "<string>",
        "steps": "<array>",
        "mergeIntoNodeIds": [
          "<string>"
        ],
        "content": "<string>"
      }
    ]
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}

{
  "type": "forbidden",
  "code": "permission_denied",
  "message": "You do not have permission to access this resource"
}

{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}

{
  "type": "rate_limit",
  "code": "too_many_requests",
  "message": "Rate limit exceeded"
}

{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

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 /graph instead.

title

string

Minimum string length: 1

description

string | null

branchingMode

enum<string>

Scripted flows only. How a run walks the graph. DETERMINISTIC ("Simulate every path" in the app) places one call per variant, each following its path exactly whatever the agent says. ADAPTIVE ("Adapt to your agent") collapses the paths into one call PER PERSONA, on which the simulated customer picks a branch from what the agent actually said. Both modes speak the exact authored lines, and neither changes how metrics or expectations grade.

Available options:

DETERMINISTIC,

ADAPTIVE

agentIds

string<uuid>[]

Replaces the linked agents. Omit to leave them unchanged. An improv flow must keep at least one; a scripted flow can be left with none.

agentExpectations

object[]

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

Show child attributes

Response

The updated customer flow

data

Scripted · object

required

The conversation a simulated customer has with the agent under test.

Scripted
Improv
Voicemail

Show child attributes

API Reference

Health

CLI Auth

Agent Endpoint

Agent

Call

Chat

Metric

Metric Policy

Metric Collection Job

Simulation Persona

Simulation

Simulation Environment

Simulation Run Plan

Simulation Run Plan Job

Simulation Job

Customer Flow

Customer Flow Edge Case

HTTP Request Definition

Webhook

Issue

Knowledge Base

Config

Update a customer flow

Authorizations

Path Parameters

Body

Response