Migrate Agents to a template revision
Starts a migration for Agents created from this template. A dry run is used by default. Review its result before setting dryRun to false. Use sectionsToMigrate to limit the change and avoid forcing over customer overrides unless that replacement is explicitly intended.
OpenAPI
````yaml post /api/v2/templates/{templateId}/migrate
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/templates/{templateId}/migrate:
post:
tags:
- Agent Templates
summary: Migrate Agents to a template revision
description: >
Starts a migration for Agents created from this template. A dry run is
used by default. Review its result before setting dryRun to false. Use
sectionsToMigrate to limit the change and avoid forcing over customer
overrides unless that replacement is explicitly intended.
operationId: migrationsPostMigrate
parameters:
- name: templateId
in: path
required: true
description: ''
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
dryRun:
type: boolean
default: true
sectionsToMigrate:
type: array
items:
type: string
forceMigrateOverriddenFields:
type: boolean
default: false
responses:
'200':
description: Inline migration result
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
allOf:
- type: object
additionalProperties: true
'202':
description: Migration queued
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
taskId:
type: string
status:
type: string
statusEndpoint:
type: string
message:
type: string
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
