v1

latestOpenAPI 3.1.02026-07-26490367.2 KB

Update Customer

Updates the specific customer by setting the values of the parameters provided. Only provided parameters will be changed.

put/customers/{id}

Path parameters

idstring required

The _id of the customer you wish to update.

Request body

type'individual' | 'company' required

This is the customer type.

namestring required

The customer's full name.

phoneNumberstring

Customer's mobile phone number in international format.

emailAddressstring

Customer's email address.

status'active' | 'inactive' required

This is the status of the customer.

metadatastring json

The customer metadata object in key-value pair. This can be useful for storing additional information about the customer in a structured format

Response

Customer updated successfully.

statusCodeinteger

Status code of the response. 200 indicates a successful request.

messagestring

Human-readable description of the result.