For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
      • Datasphere
      • Fabric
        • Addresses
        • AI Agents
        • Call Flows
          • create
          • delete
          • deployVersion
          • get
          • list
          • listAddresses
          • listVersions
          • update
        • Conference Rooms
        • cXML Applications
        • cXML Scripts
        • cXML Webhooks
        • FreeSWITCH Connectors
        • RELAY Applications
        • Resources
        • SIP Endpoints
        • SIP Gateways
        • Subscribers
        • SWML Scripts
        • SWML Webhooks
        • Tokens
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientFabricCall Flows

update

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

Conference Rooms

Next
Built with

Replace a call flow resource. Uses PUT for full replacement.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Call Flow.

Request

document_versionintegerRequired
The current revision of the call flow. Must equal the call flow's existing `document_version + 1`.
flow_dataobjectRequired
Call Flow Builder state, stored as an opaque JSON object.
relaymlobjectRequired
The calling SWML document this Call Flow should execute. Uses [calling SWML methods](/docs/swml/reference/calling).
titlestringOptional
The name of the Call Flow

Response

idstringRequiredformat: "uuid"
Unique ID of the Call Flow.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the Call Flow Fabric Resource
typeenumRequired
Type of the Fabric Resource
Allowed values:
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
call_flowobjectRequired
Call Flow data.

Response Example

Response
1{
2  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
3  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4  "display_name": "Booking Assistant",
5  "type": "call_flow",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "call_flow": {
9    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10    "title": "Booking Assistant",
11    "flow_data": {},
12    "relayml": {
13      "sections": {
14        "main": [
15          {
16            "denoise": {},
17            "play": {
18              "url": "https://cdn.signalwire.com/swml/audio.mp3"
19            }
20          }
21        ]
22      },
23      "version": "1.0.0"
24    },
25    "document_version": 1
26  }
27}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const updated = await client.fabric.callFlows.update("flow-id", {
10  title: "Updated IVR Flow",
11});
12console.log(`Updated: ${updated.display_name}`);