Vapi · Schema

UpdateTestSuiteDto

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
name string This is the name of the test suite.
phoneNumberId string This is the phone number ID associated with this test suite.
testerPlan object Override the default tester plan by providing custom assistant configuration for the test agent. We recommend only using this if you are confident, as we have already set sensible defaults on the test
targetPlan object These are the configuration for the assistant / phone number that is being tested.
View JSON Schema on GitHub

JSON Schema

vapi-updatetestsuitedto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateTestSuiteDto",
  "title": "UpdateTestSuiteDto",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "This is the name of the test suite.",
      "maxLength": 80
    },
    "phoneNumberId": {
      "type": "string",
      "description": "This is the phone number ID associated with this test suite.",
      "deprecated": true
    },
    "testerPlan": {
      "description": "Override the default tester plan by providing custom assistant configuration for the test agent.\n\nWe recommend only using this if you are confident, as we have already set sensible defaults on the tester plan.",
      "allOf": [
        {
          "$ref": "#/components/schemas/TesterPlan"
        }
      ]
    },
    "targetPlan": {
      "description": "These are the configuration for the assistant / phone number that is being tested.",
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetPlan"
        }
      ]
    }
  }
}