Delete Project

This section provides instructions to use the /project/:projectId endpoint to delete an existing project. A project will be deleted if all the agents are removed from it.

Step1: Prepare Your Request

• Endpoint: /project/:projectId

• Method: DELETE

• URL: https://api.talkstackai.com/project/:projectId

• Headers: Include Content-Type: application/json.

• Authorization: Bearer token or x-api-key in Headers

Step 2: Request Parameters

• projectId: The id of the project that needs to be deleted.

Step 3: Request Body(optional)

• cascade: This parameter takes a Boolean value. By default its value is false. If you want to delete the project and all agents and phone numbers attached to it, pass cascade as true. If cascade is not sent or false then you will have to remove all agents and phone numbers from the project.

{
    "cascade": true
}

Step 3: Send the Request

Use your preferred HTTP client to send the DELETE request.

Step 4: Handle the request

Success Response:

• Status Code: 200 OK

• Body:

{
    "message": "successfully deleted project.",
    "status": "success"
}

Troubleshooting

• 400 Bad Request: If both projectId is not defined.

• 401 Unauthorized: If the user is unauthorized or the token is missing.

• 404 Not found: If the project with the given projectId is not found.

• 500 Internal Server Error: For errors in deleting the project.

Last updated 14 hours ago