> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # Update call flow PUT https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/call_flows/{id} Content-Type: application/json Saves a new editable revision of a Call Flow in your SignalWire project. Supply the next required `document_version`, then make the saved revision live with [Deploy call flow version](/docs/apis/rest/call-flows/deploy-call-flow-version). Directly authored SWML belongs in [Update SWML Script](/docs/apis/rest/swml-scripts/update-swml-script). #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/call-flows/update-call-flow ## Authentication - `Authorization` header (basic auth, required) — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ``` ## Request ### Path parameters - `id` (string, required) — Unique ID of a Call Flow. ### Body (application/json) This endpoint expects a CallFlowUpdateRequest. - `document_version` (integer, required) — The current revision of the call flow. Must equal the call flow's existing `document_version + 1`. - `flow_data` (CallFlowUpdateRequestFlowData, required) — Call Flow Builder state, stored as an opaque JSON object. - `relayml` (CallFlowUpdateRequestRelayml, required) — The calling SWML document this Call Flow should execute. Uses [calling SWML methods](/docs/swml/reference/calling). - `title` (string, optional) — The name of the Call Flow ## Response ### 200 The request has succeeded. - `id` (string, required) — Unique ID of the Call Flow. - `project_id` (string, required) — Unique ID of the Project. - `display_name` (string, required) — Display name of the Call Flow Fabric Resource - `type` (enum, required) — Type of the Fabric Resource - Allowed values: `call_flow` - `created_at` (datetime, required) — Date and time when the resource was created. - `updated_at` (datetime, required) — Date and time when the resource was updated. - `call_flow` (CallFlow, required) — Call Flow data. ## Errors ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 404 Not Found Error The server cannot find the requested resource. - `error` (enum, required) - Allowed values: `Not Found` ### 422 Unprocessable Entity Error The request contains invalid parameters. See errors for details. - `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors. ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### CallFlowUpdateRequestFlowData Call Flow Builder state, stored as an opaque JSON object. ### CallFlowUpdateRequestRelayml The calling SWML document this Call Flow should execute. Uses [calling SWML methods](/docs/swml/reference/calling). ### CallFlow - `id` (string, required) — Unique ID of a Call Flow. - `title` (string, required) — The name of the Call Flow - `flow_data` (CallFlowFlowData, optional) — Call Flow Builder state, stored as an opaque JSON object. Produced and consumed by the SignalWire Call Flow Builder UI; not used by SWML execution. - `relayml` (CallFlowRelayml, optional) — The calling SWML document this Call Flow executes. Uses [calling SWML methods](/docs/swml/reference/calling). - `document_version` (integer, optional) — The current revision of the call flow. Every update must increase this number. ### Types.StatusCodes.RestApiErrorItem Details about a specific error. - `type` (string, required) — The category of error. - `code` (string, required) — A specific error code. - `message` (string, required) — A description of what caused the error. - `url` (string, required) — A link to documentation about this error. - `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable. ### CallFlowFlowData Call Flow Builder state, stored as an opaque JSON object. Produced and consumed by the SignalWire Call Flow Builder UI; not used by SWML execution. ### CallFlowRelayml The calling SWML document this Call Flow executes. Uses [calling SWML methods](/docs/swml/reference/calling). ## Examples **Request** ```json { "document_version": 2, "relayml": { "sections": { "main": [ { "play": { "url": "https://cdn.signalwire.com/swml/audio.mp3" } } ] }, "version": "1.0.0" }, "title": "Updated Welcome Call Flow" } ``` **Response** ```json { "id": "993ed018-9e79-4e50-b97b-984bd5534095", "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780", "display_name": "Welcome Call Flow", "type": "call_flow", "created_at": "2024-05-06T12:20:00Z", "updated_at": "2024-05-06T12:25:00Z", "call_flow": { "id": "993ed018-9e79-4e50-b97b-984bd5534095", "title": "Welcome Call Flow", "flow_data": {}, "relayml": { "sections": { "main": [ { "play": { "url": "https://cdn.signalwire.com/swml/audio.mp3" } } ] }, "version": "1.0.0" }, "document_version": 1 } } ``` **SDK Code** ```python Update a Call Flow import requests url = "https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id" payload = { "document_version": 2, "relayml": { "sections": { "main": [{ "play": { "url": "https://cdn.signalwire.com/swml/audio.mp3" } }] }, "version": "1.0.0" }, "title": "Updated Welcome Call Flow" } headers = { "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers, auth=("", "")) print(response.json()) ``` ```javascript Update a Call Flow const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id'; const credentials = btoa(":"); const options = { method: 'PUT', headers: { Authorization: `Basic ${credentials}`, 'Content-Type': 'application/json' }, body: '{"document_version":2,"relayml":{"sections":{"main":[{"play":{"url":"https://cdn.signalwire.com/swml/audio.mp3"}}]},"version":"1.0.0"},"title":"Updated Welcome Call Flow"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Update a Call Flow package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id" payload := strings.NewReader("{\n \"document_version\": 2,\n \"relayml\": {\n \"sections\": {\n \"main\": [\n {\n \"play\": {\n \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\"\n }\n }\n ]\n },\n \"version\": \"1.0.0\"\n },\n \"title\": \"Updated Welcome Call Flow\"\n}") req, _ := http.NewRequest("PUT", url, payload) req.SetBasicAuth("", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Update a Call Flow require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request.basic_auth("", "") request["Content-Type"] = 'application/json' request.body = "{\n \"document_version\": 2,\n \"relayml\": {\n \"sections\": {\n \"main\": [\n {\n \"play\": {\n \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\"\n }\n }\n ]\n },\n \"version\": \"1.0.0\"\n },\n \"title\": \"Updated Welcome Call Flow\"\n}" response = http.request(request) puts response.read_body ``` ```java Update a Call Flow import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id") .basicAuth("", "") .header("Content-Type", "application/json") .body("{\n \"document_version\": 2,\n \"relayml\": {\n \"sections\": {\n \"main\": [\n {\n \"play\": {\n \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\"\n }\n }\n ]\n },\n \"version\": \"1.0.0\"\n },\n \"title\": \"Updated Welcome Call Flow\"\n}") .asString(); ``` ```php Update a Call Flow request('PUT', 'https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id', [ 'body' => '{ "document_version": 2, "relayml": { "sections": { "main": [ { "play": { "url": "https://cdn.signalwire.com/swml/audio.mp3" } } ] }, "version": "1.0.0" }, "title": "Updated Welcome Call Flow" }', 'headers' => [ 'Content-Type' => 'application/json', ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp Update a Call Flow using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.PUT); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"document_version\": 2,\n \"relayml\": {\n \"sections\": {\n \"main\": [\n {\n \"play\": {\n \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\"\n }\n }\n ]\n },\n \"version\": \"1.0.0\"\n },\n \"title\": \"Updated Welcome Call Flow\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Update a Call Flow import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = [ "Authorization": "Basic \(credentials)", "Content-Type": "application/json" ] let parameters = [ "document_version": 2, "relayml": [ "sections": ["main": [["play": ["url": "https://cdn.signalwire.com/swml/audio.mp3"]]]], "version": "1.0.0" ], "title": "Updated Welcome Call Flow" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```