Update Customer
Update an existing customer in Customerscore.
For interactive API documentation, see the Swagger reference (opens in a new tab).
Endpoint
| Method | URL |
|---|---|
| PUT | https://api.customerscore.io/api/v1/customer/{customerExternalId} |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
customerExternalId | string | Yes | Customer external ID |
Request Body
All fields in the request body are optional. Only include the fields you want to update.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Customer name |
is_churned | boolean | No | Flag indicating if the customer has churned |
is_unsubscribed | boolean | No | Flag indicating if the customer is unsubscribed |
churned_date | string | No | Date when the customer churned in ISO8601 format (YYYY-MM-DD) |
owner_email | string | No | Owner email address. If provided, updates the customer owner to the user with this email |
Example Request
curl -X PUT "https://api.customerscore.io/api/v1/customer/12345" \
-H "Content-Type: application/json" \
-H "customerscore-key: your-generated-key" \
-d '{
"name": "Acme Corporation",
"is_churned": true,
"churned_date": "2024-12-31",
"owner_email": "owner@example.com"
}'Response Codes
| Code | Description |
|---|---|
| 200 | The customer has been successfully updated |
| 400 | Bad request |
| 401 | Unauthorized - Missing customerscore-key in the header |
| 403 | Forbidden - Invalid key |
| 404 | Customer not found |
| 405 | Method Not Allowed - Only PUT method is allowed |
| 406 | Not Acceptable |