Delete Supplier Contact

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

Endpoint

DELETE /v1/supplier-contacts/supplier-contacts/:id

Authentication

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

Required Scope

supplier-contacts:write

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Supplier contact ID.

Request Body

This endpoint does not accept a request body.

Example Request

cURL

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

JavaScript

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

HTTP

DELETE /v1/supplier-contacts/supplier-contacts/suppliercontact-vwx123yza4567890 HTTP/1.1
Host: api.crewsum.com
x-api-key: <your-api-key>

Response

On success, the API returns HTTP 200 OK.

Example Response

The message currently says “supplier” instead of “supplier contact”. Do not match on the message text.

{
  "message": "Successfully deleted supplier suppliercontact-vwx123yza4567890"
}

Behavior

• This is a soft delete. The API sets isDeleted to true and keeps the record.
• Deleted contacts no longer appear in List Supplier Contacts. Get Supplier Contact still returns them, with "isDeleted": true.
• The API cannot undo a delete.
• An unknown ID still returns 200.
• After the delete, Crewsum sends the supplier-contacts.deleted webhook event. The payload is { "contacts": [{ "supplier": <supplier>, "supplierContact": <contact> }] }, with "isDeleted": true on the contact. For an unknown ID, the event is still sent, with an empty contacts array.

Error Responses

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

Authentication and scope failures are described in Errors.

Related Webhooks

supplier-contacts.deleted View webhook event details.