Skip to main content
DELETE
/
agents
/
{id}
Delete agent
curl --request DELETE \
  --url https://api.instaview.sk/agents/{id} \
  --header 'Authorization: Bearer <token>'
true
Permanently deletes an agent (interview template). This action cannot be undone.

Overview

The delete agent endpoint permanently removes an agent configuration and all its associated interviews from your account. This is useful for removing outdated templates.

Use Cases

  • Remove Unused Agents: Clean up agents that are no longer needed
  • Archive Old Configurations: Permanently remove outdated agent configurations
  • Compliance: Delete agents for data retention compliance
  • Organization: Maintain a clean agent library

Permanent Deletion Behavior

Deleting an agent permanently removes the template from your account. This action is irreversible and will also remove all interviews that were created using this agent.

Impact on Existing Interviews

Deleting an agent does not affect interviews that have already been scheduled or completed. Those interviews retain their association with the agent for historical accuracy. However, you cannot create new interviews using a deleted agent.

Company Isolation

You can only delete agents that belong to your API key’s company. Attempting to delete an agent from another company will result in a 403 Forbidden error.

Error Scenarios

  • 404 Not Found: Agent doesn’t exist or has already been deleted
  • 403 Forbidden: Agent belongs to a different company

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required

Query Parameters

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

200 - application/json

The response is of type boolean.