Delete Project

This endpoint soft-deletes an existing project by ID.

Endpoint

DELETE /v1/projects/projects/:id

Authentication

Include your API key in the x-api-key header. See Authentication.

Required Scope

projects:write

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Project ID to delete.

Request Body

This endpoint does not accept a request body.

Example Request

cURL

curl -X DELETE "https://api.crewsum.com/v1/projects/projects/project-mno123pqr4567890" \
  -H "x-api-key: $CREWSUM_API_KEY"

JavaScript

const response = await fetch(
  "https://api.crewsum.com/v1/projects/projects/project-mno123pqr4567890",
  {
    method: "DELETE",
    headers: { "x-api-key": process.env.CREWSUM_API_KEY },
  },
);
const result = await response.json();

HTTP

DELETE /v1/projects/projects/project-mno123pqr4567890 HTTP/1.1
Host: api.crewsum.com
x-api-key: <your-api-key>

Response

On success, the API returns HTTP 200 OK.

Example Response

{
  "message": "Successfully deleted project: project-mno123pqr4567890"
}

Behavior

• The project is soft-deleted: it is marked isDeleted: true. Get Project still returns it. List Projects does not.
• The delete also soft-deletes all of the project’s contact associations and the project’s default task.
• Other tasks in the project are not deleted. They keep isDeleted: false and still appear in List Tasks. Delete them separately with Delete Task if needed.
• If no project exists for the ID, the API still returns 200. No webhook is sent in that case.
• After the project is deleted, Crewsum emits the projects.deleted webhook event. A webhook delivery failure does not change the API response.

Error Responses

Status	Meaning
400	The project ID was missing from the route.
500	Crewsum could not delete the project. The message is Error deleting project: <id>.

Authentication and scope failures are described in Errors.

Related Webhooks

projects.deleted View webhook event details.