Update Outbound IVR Flow

PUT

/v1/outbound-ivr/flows/{id}

Full replace. Send the complete flow — omitted fields are cleared and steps replaces the entire script.

Updating a flow does not affect calls already in progress. Each request snapshots the flow's steps when it is created, so an in-flight call keeps asking the questions that existed when it was placed. Editing a flow mid-campaign is safe.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Updated flow

Bodyapplication/json

🟠403

🟠400FlowValidationError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.voxa.sa/v1/outbound-ivr/flows/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Sales pre-qualification",
    "steps": [
        {
            "key": "budget",
            "type": 1,
            "questionProps": {
                "audioFileUrl": "http://example.com",
                "options": [
                    {
                        "digit": "1",
                        "description": "Confirm the appointment",
                        "responseMessageFileUrl": "http://example.com"
                    }
                ]
            }
        }
    ],
    "welcomeAudioFileUrl": "http://example.com",
    "completionAudioFileUrl": "http://example.com",
    "noInputAudioFileUrl": "http://example.com",
    "continueOnNoInput": false,
    "maxAudioRetries": 2,
    "inputTimeoutMs": 6000,
    "digitTimeoutMs": 3000
}'

Response Example

200 - Example 1

{
    "name": "Sales pre-qualification",
    "steps": [
        {
            "key": "budget",
            "type": 1,
            "questionProps": {
                "audioFileUrl": "http://example.com",
                "options": [
                    {
                        "digit": "1",
                        "description": "Confirm the appointment",
                        "responseMessageFileUrl": "http://example.com"
                    }
                ]
            }
        }
    ],
    "welcomeAudioFileUrl": "http://example.com",
    "completionAudioFileUrl": "http://example.com",
    "noInputAudioFileUrl": "http://example.com",
    "continueOnNoInput": false,
    "maxAudioRetries": 2,
    "inputTimeoutMs": 6000,
    "digitTimeoutMs": 3000,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
    "creationTime": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-08-14 17:40:40

Get Outbound IVR Flow

Delete Outbound IVR Flow