Delete Supplier

This endpoint soft-deletes a supplier. The record is marked as deleted but is not removed.

Endpoint

DELETE /v1/suppliers/suppliers/:id

Authentication

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

Required Scope

suppliers:write

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Supplier ID.

Request Body

This endpoint does not accept a request body.

Example Request

cURL

curl -X DELETE "https://api.crewsum.com/v1/suppliers/suppliers/supplier-stu123vwx4567890" \
  -H "x-api-key: $CREWSUM_API_KEY"

JavaScript

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

HTTP

DELETE /v1/suppliers/suppliers/supplier-stu123vwx4567890 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 supplier supplier-stu123vwx4567890"
}

Behavior

• This is a soft delete. The API sets isDeleted to true and keeps the record.
• Deleted suppliers no longer appear in List Suppliers. Get Supplier still returns them, with "isDeleted": true.
• The supplier’s contacts are not deleted.
• The API cannot undo a delete.
• An unknown ID still returns 200, and no webhook is sent.
• After an existing supplier is deleted, Crewsum sends the suppliers.deleted webhook event. The payload is { "suppliers": [<supplier>] }, with "isDeleted": true.

Error Responses

Status	Meaning
400	The ID path segment was empty (for example, a trailing slash). Message: SupplierID not supplied.
500	Crewsum could not delete the supplier. Message: Error deleting supplier <id>.

Authentication and scope failures are described in Errors.

Related Webhooks

suppliers.deleted View webhook event details.