Update Customer
Update an existing customer's information. This endpoint supports partial updates - you only need to include the fields you want to change.
Partial Updates: Only send the fields you want to update. Omitted fields remain unchanged.
Email Updates:
When changing email, the new email must still be unique within the team. Use find-by-email first to check if the new email is available.
Address Updates: Address updates replace the entire address object. You cannot update individual address fields - you must provide the complete address.
To remove an address, send null as the value.
Contact Updates: Contacts cannot be updated via this endpoint. Use dedicated contact management endpoints (if available) or manage contacts through the web interface.
Removing Fields:
- To remove website or phone: send
nullor empty string - To remove addresses: send
null
Timestamps:
The updatedAt timestamp is automatically updated to the current time when any field is modified.
Use Cases:
- Update customer contact information
- Change customer status (active/inactive)
- Update billing or shipping addresses
- Modify customer name or website
Best Practices:
- Get current customer data first to avoid overwriting fields unintentionally
- Only send fields you want to change
- For address updates, provide complete address objects
- Check email uniqueness before updating email
Header Parameters
Path Parameters
The unique identifier of the customer to update
Body Parameters
Customer or business name (1-255 characters, non-empty)
Primary contact email (must be unique within team)
Primary phone number (max 50 characters, international format recommended)
Website URL (max 255 characters, should include protocol)
Customer status (defaults to "active" if not specified)
activeinactiveAddress structure for billing and shipping addresses
Show child attributes
Address structure for billing and shipping addresses
Show child attributes
Contact persons (optional, array of contact objects)
Show child attributes
Response
Response Attributes
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
What made this section unhelpful for you?
Response
What made this section unhelpful for you?