Delete End Customer

This endpoint soft-deletes an existing end customer by ID.

Endpoint

DELETE /v1/end-customers/end-customers/:id

Authentication

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

Required Scope

end-customers:write

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	End customer ID to delete.

Request Body

This endpoint does not accept a request body.

Example Request

cURL

curl -X DELETE "https://api.crewsum.com/v1/end-customers/end-customers/endcustomer-abc123def4567890" \
  -H "x-api-key: $CREWSUM_API_KEY"

JavaScript

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

HTTP

DELETE /v1/end-customers/end-customers/endcustomer-abc123def4567890 HTTP/1.1
Host: api.crewsum.com
x-api-key: <your-api-key>

Response

On success, the API returns HTTP 200 OK. The response has no data field.

Example Response

{
  "message": "Successfully deleted end customer: endcustomer-abc123def4567890"
}

Behavior

• This is a soft delete. The end customer is marked isDeleted: true. It no longer appears in List End Customers, but Get End Customer still returns it.
• Only the end customer record changes. Projects that use this end customer keep their endCustomerId, and their responses show endCustomerDeleted: true.
• The API does not check that the end customer exists. An unknown ID returns 200 with the success message, and no webhook is sent. Deleting an end customer that is already deleted also returns 200.
• After the end customer is deleted, Crewsum attempts to send the end-customers.deleted webhook event. A webhook failure does not change the response.

Error Responses

Status	Meaning
400	{"message": "EndCustomerID not supplied"}. The ID path segment is empty.
500	{"message": "Error deleting end customer: <id>"}. Crewsum could not delete the end customer.

Authentication and scope failures are described in Errors.

Related Webhooks

end-customers.deleted View webhook event details.