Update End Customer

This endpoint updates an existing end customer by ID.

Endpoint

PUT /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 update.

Request Body

Send only the fields you want to change. Omitted fields keep their current values. The server does not validate the request body against a schema, so a value of the wrong type is not rejected with 400.

Field	Type	Required	Description
name	string	No	New end customer name. null is rejected by the database and returns 500.
description	string | null	No	New description. Send null to clear it.
clientId	string | null	No	New client. Send null to remove the client. A client that does not exist in your account, or is deleted, returns 400.
email	string | null	No	New email. Send null to clear it. The format is not checked.
phoneNumber	string | null	No	New phone number. Send null to clear it.
address	string | null	No	New address. Send null to clear it.
notes	string | null	No	New internal notes. Send null to clear them.
isArchived	boolean	No	New archive state.

Example Request Body

{
  "description": "Updated description",
  "notes": null,
  "isArchived": false
}

Example Request

cURL

curl -X PUT "https://api.crewsum.com/v1/end-customers/end-customers/endcustomer-abc123def4567890" \
  -H "x-api-key: $CREWSUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated description",
    "notes": null,
    "isArchived": false
  }'

JavaScript

const response = await fetch(
  "https://api.crewsum.com/v1/end-customers/end-customers/endcustomer-abc123def4567890",
  {
    method: "PUT",
    headers: {
      "x-api-key": process.env.CREWSUM_API_KEY,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      description: "Updated description",
      notes: null,
      isArchived: false,
    }),
  },
);
const result = await response.json();

HTTP

PUT /v1/end-customers/end-customers/endcustomer-abc123def4567890 HTTP/1.1
Host: api.crewsum.com
x-api-key: <your-api-key>
Content-Type: application/json

{
  "description": "Updated description",
  "notes": null,
  "isArchived": false
}

Response

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

Example Response

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

Behavior

• Every successful update sets updatedAt to the current time.
• Changing clientId does not change the projects that use this end customer.
• Archiving an end customer does not archive its projects.
• The API does not check that the end customer exists. An unknown ID returns 200 with the success message, nothing is changed, and no webhook is sent.
• After the end customer is updated, Crewsum attempts to send the end-customers.updated webhook event. A webhook failure does not change the response.

Error Responses

Status	Meaning
400	{"message": "EndCustomerID missing"}. The ID path segment is empty.
400	{"message": "Client not found"}. No client with this clientId exists in your account, or the client is deleted. Nothing is changed.
500	{"message": "Error updating end customer: <id>"}. Crewsum could not update the end customer, for example because name is null.
500	The request has no JSON body. The response uses the standard server error shape.

Authentication and scope failures are described in Errors.

Related Webhooks

end-customers.updated View webhook event details.