Vapi · Schema

DeleteCallDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
ids array These are the Call IDs to be bulk deleted. If provided, the call ID if any in the request query will be ignored When requesting a bulk delete, updates when a call is deleted will be sent as a webhook
View JSON Schema on GitHub

JSON Schema

vapi-deletecalldto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeleteCallDTO",
  "title": "DeleteCallDTO",
  "type": "object",
  "properties": {
    "ids": {
      "description": "These are the Call IDs to be bulk deleted.\nIf provided, the call ID if any in the request query will be ignored\nWhen requesting a bulk delete, updates when a call is deleted will be sent as a webhook to the server URL configured in the Org settings.\nIt may take up to a few hours to complete the bulk delete, and will be asynchronous.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}