> ## Documentation Index > Fetch the complete documentation index at: https://docs.firetone.com.au/llms.txt > Use this file to discover all available pages before exploring further. # Update an IVR flow's metadata > Name, description and team only. Partial: an omitted field is untouched. The graph is replaced through PUT /ivr-flows/{id}/draft. ## OpenAPI ````yaml /api-reference/openapi-public.json patch /ivr-flows/{id} openapi: 3.0.3 info: description: >- The API your own systems use: place and follow calls, have an AI agent call someone, run campaigns and get their results, keep contacts in step with your CRM, and receive signed webhooks. Authenticate with an integration key (Authorization: Bearer ft_...), used only from the IP addresses it allows. title: FireTone API version: 0.1.0 servers: - description: Your platform's API host url: https://{host}/api/v1 variables: host: default: api.firet.one security: - bearerAuth: [] tags: - name: Auth - description: >- Live calls and what can be done to them: hang up, hold, transfer, park, merge, monitor, whisper; the Desk's own call. name: Calls - description: 'Outbound campaigns: contacts, attempts, outcomes.' name: Campaigns - description: 'Customers: who called, what is known about them, and their memory.' name: Contacts - description: What was said on an AI call, and the review of it. name: Conversations - name: IVR - description: >- Your own systems: HTTP connections an IVR calls mid-call, and webhooks for call events. Tenant URLs must be public https addresses. name: Integrations - name: Live - name: Provisioning - name: Reporting - description: Tickets raised by people, agents and the API. name: Tickets - description: Messages left for an extension or a queue. name: Voicemail paths: /ivr-flows/{id}: patch: tags: - IVR summary: Update an IVR flow's metadata description: >- Name, description and team only. Partial: an omitted field is untouched. The graph is replaced through PUT /ivr-flows/{id}/draft. operationId: patchIvrFlowsId parameters: - in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIVRFlowRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IVRFlow' description: OK '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' components: schemas: UpdateIVRFlowRequest: description: >- All fields optional. Metadata only: the graph is replaced through PUT /ivr-flows/{id}/draft. properties: campaign_kind: description: >- Checked against the direction the flow will have after this patch, not the one it has now. Turning an outbound flow inbound while it still carries a campaign_kind is refused; clear it in the same request. enum: - voice_broadcast - auto_dial nullable: true type: string description: nullable: true type: string direction: enum: - inbound - outbound type: string name: type: string team_id: format: uuid nullable: true type: string test_caller: description: >- Who a test call tells the flow is calling, E.164 (read in the organisation's region when typed without +). Null for the tester's own extension. type: string test_number: description: >- 3-8 digits any extension of the organisation dials to walk through this flow as a test. Never reachable from outside. Refused if it is an extension, a park slot (701-799) or another flow's test number. Null to remove. type: string test_revision: description: Which version a test call runs. Default draft. enum: - draft - published type: string type: object IVRFlow: description: >- A call flow as a graph. `published_revision` is the revision answering calls; a flow with none takes no traffic. `draft_revision` is what the designer edits. properties: campaign_kind: description: >- Which campaign kind an outbound flow was drawn for. Null means it suits both, and is the only valid value on an inbound flow. enum: - voice_broadcast - auto_dial nullable: true type: string created_at: format: date-time type: string description: nullable: true type: string direction: description: >- Which way the call is going when this graph runs. An inbound flow answers a number; an outbound one runs after a campaign's contact picks up. A campaign will not accept an inbound flow. enum: - inbound - outbound type: string draft_revision: type: integer id: format: uuid type: string name: type: string organisation_id: format: uuid type: string published_revision: description: >- The revision currently answering calls. Null means the flow has never been published and must not receive traffic. nullable: true type: integer team_id: format: uuid nullable: true type: string test_caller: description: >- Who a test call tells the flow is calling, E.164 (read in the organisation's region when typed without +). Null for the tester's own extension. type: string test_number: description: >- 3-8 digits any extension of the organisation dials to walk through this flow as a test. Never reachable from outside. Refused if it is an extension, a park slot (701-799) or another flow's test number. Null to remove. type: string test_revision: description: Which version a test call runs. Default draft. enum: - draft - published type: string updated_at: format: date-time type: string required: - id - organisation_id - name - direction - draft_revision - created_at - updated_at type: object Error: properties: error: properties: code: enum: - invalid_request - invalid_credentials - unauthenticated - forbidden - not_found - conflict - internal type: string message: type: string required: - code - message type: object required: - error type: object responses: BadRequest: content: application/json: schema: $ref: '#/components/schemas/Error' description: The request is not valid. The message names every field that is wrong. Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Missing, invalid or expired token Forbidden: content: application/json: schema: $ref: '#/components/schemas/Error' description: Outside the caller's scope, or insufficient role NotFound: content: application/json: schema: $ref: '#/components/schemas/Error' description: Not found, or not visible to the caller Conflict: content: application/json: schema: $ref: '#/components/schemas/Error' description: >- The row is still referenced, or a unique value is taken. The message names what still points at it. securitySchemes: bearerAuth: bearerFormat: JWT or API key description: >- Every request sends `Authorization: Bearer `. The token is either a panel session (a JWT from /auth/login, 12 hours) or an API key `ft__`. An API key is accepted only from an address on its IP allowlist (403 ip_not_allowed otherwise; 403 ip_allowlist_required for an old key that has none), is limited to its rate per minute (429 rate_limited with Retry-After; X-RateLimit-Limit/Remaining/Reset on every response), and at most 60 call placements a minute. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.