---
title: "Update IVR"
method: PUT
path: "/v2/partition/{partitionId}/account/{accountId}/ivr/{ivrId}"
tags: ["IVR"]
---

# Update IVR

`PUT /v2/partition/{partitionId}/account/{accountId}/ivr/{ivrId}`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/partition/{partitionId}/account/{accountId}/ivr/{ivrId}`
- Auth: API key in header `X-AUTH-TOKEN`

Use to update an IVR.  <span hidden>See <a href="ivr/ivr.html#updateIvr">here</a> for details.</span>

## Path parameters

- `accountId` string, required
- `ivrId` string, required
- `partitionId` string, required

## Request body

- IVRX
  - `id` string: The id of the IVR. Automatic primary key.
  - `accountId` string
  - `partitionId` string
  - `name` string, required: Choose a descriptive name for the IVR.
  - `top` string
  - `left` string
  - `fixedPosition` boolean
  - `ivrComponents` IVRComponentX[], required: The list of components that make up the IVR.
    - `id` string, required: The id of the IVR Component. Chosen by the api user but it must be distinct from other IVR components which are under the same IVR. There is no requirement for it to be distinct from unrelated IVR components.
    - `left` string
    - `top` string
    - `name` string: Choose a descriptive name for the IVR component.
    - `type` 'HANGUP' | 'MENU' | 'DIRECTORY' | 'GROUP' | 'INCOMING' | 'SCHEDULE' | 'DTMF' | 'MENU_FAILURE' | 'SCHEDULE_RULE_COMPONENT' | 'USER' | 'LINE_HUNTGROUP' | 'FORWARD', required
  - `ivrComponentMappings` IVRComponentMappingX[], required: The list of connections between IVR components.
    - `fromIvrComponentId` string, required: The id of the IVR Component that is being mapped from. Refers to <a href="#/~schema/IVRComponentX">IVRComponent.id</a><br/><br/> RARELY may also refer to <a href="#/~schema/GROUP">GROUP.timeoutComponentId</a>
    - `toIvrComponentId` string, required: The id of the IVR Component that is being mapped to. Refers to <a href="#/~schema/IVRComponentX">IVRComponent.id</a>

## Response `200`

Successful operation

- IVRX
  - `id` string: The id of the IVR. Automatic primary key.
  - `accountId` string
  - `partitionId` string
  - `name` string, required: Choose a descriptive name for the IVR.
  - `top` string
  - `left` string
  - `fixedPosition` boolean
  - `ivrComponents` IVRComponentX[], required: The list of components that make up the IVR.
    - `id` string, required: The id of the IVR Component. Chosen by the api user but it must be distinct from other IVR components which are under the same IVR. There is no requirement for it to be distinct from unrelated IVR components.
    - `left` string
    - `top` string
    - `name` string: Choose a descriptive name for the IVR component.
    - `type` 'HANGUP' | 'MENU' | 'DIRECTORY' | 'GROUP' | 'INCOMING' | 'SCHEDULE' | 'DTMF' | 'MENU_FAILURE' | 'SCHEDULE_RULE_COMPONENT' | 'USER' | 'LINE_HUNTGROUP' | 'FORWARD', required
  - `ivrComponentMappings` IVRComponentMappingX[], required: The list of connections between IVR components.
    - `fromIvrComponentId` string, required: The id of the IVR Component that is being mapped from. Refers to <a href="#/~schema/IVRComponentX">IVRComponent.id</a><br/><br/> RARELY may also refer to <a href="#/~schema/GROUP">GROUP.timeoutComponentId</a>
    - `toIvrComponentId` string, required: The id of the IVR Component that is being mapped to. Refers to <a href="#/~schema/IVRComponentX">IVRComponent.id</a>

## Other responses

- `400`: Invalid IVR object supplied
- `401`: Unauthorized
- `404`: IVR not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/cb514a0728ed?raw)