Vapi · Schema

UpdateSimulationSuiteDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
name string This is the name of the simulation suite.
slackWebhookUrl string This is the Slack webhook URL for notifications.
simulationIds array This is the list of simulation IDs to include in the suite (replaces existing).
path string Optional folder path for organizing simulation suites. Supports up to 3 levels (e.g., "dept/feature/variant"). Set to null to remove from folder.
View JSON Schema on GitHub

JSON Schema

vapi-updatesimulationsuitedto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateSimulationSuiteDTO",
  "title": "UpdateSimulationSuiteDTO",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "This is the name of the simulation suite.",
      "maxLength": 80
    },
    "slackWebhookUrl": {
      "type": "string",
      "description": "This is the Slack webhook URL for notifications."
    },
    "simulationIds": {
      "description": "This is the list of simulation IDs to include in the suite (replaces existing).",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "path": {
      "type": "string",
      "nullable": true,
      "description": "Optional folder path for organizing simulation suites.\nSupports up to 3 levels (e.g., \"dept/feature/variant\").\nSet to null to remove from folder.",
      "maxLength": 255,
      "pattern": "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/"
    }
  }
}