Skip to main content
DELETE
/
agents
/
{id}
Delete agent
curl --request DELETE \
  --url https://api.instaview.sk/agents/{id} \
  --header 'Authorization: Bearer <token>'
true
Soft-deletes an agent (interview template) by ID. Deleted agents are not permanently removed but are hidden from list operations.

​
Overview

The delete agent endpoint performs a soft delete, meaning the agent is marked as deleted but not permanently removed from the system. This preserves data integrity and allows for potential recovery if needed.

​
Use Cases

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

​
Soft Delete Behavior

Deleted agents are soft-deleted, meaning they are hidden from list and get operations but remain in the database for audit purposes. They cannot be used for new interviews.

​
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

Agents Resource Guide

Learn about agent management

List Agents

View all active agents

Create Agent

Create new agents

Authorizations

​
Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

​
id
string<uuid>
required

Response

200 - application/json

The response is of type boolean.