Account (Patch)


Endpoint: /api/v2/customers/{CustomerID}

Method: PATCH

Auth Required: Yes (Basic or Bearer)

Description

This endpoint allows you to partially update an existing customer record in the system. You can supply only the fields you want to change. Common use cases include updating address details, customer status, industry, and sales channel associations.


URL Parameters

Parameter Type Required Description
CustomerID integer Yes Unique ID of the customer to be updated.

Query Parameters

Parameter Type Required Description
LanguageID integer No Language preference for localized data. Default is 1 .

Request Body

Submit only the fields that you wish to update. All fields are optional and nullable.

{  "Name": "string",  "CRMCustomerID": "string",  "AccountID": "string",  "Website": "string",  "IsActive": true,  "Division": "string",  "Address1": "string",  "Address2": "string",  "City": "string",  "Zip": "string",  "CountryCode": "US",  "StateProvince": "CA",  "IndustryID": 2,  "CustomerStatusID": 1,  "CustomerOption1ID": 101,  "CustomerOption2ID": 102,  "CustomerOption3ID": 103,  "SalesChannelLevel1ID": 1,  "SalesChannelLevel2ID": 2,  "CustomerOption4IDs": [1, 2, 3] }  

Success Response

Code: 200 OK

Content: Returns the updated customer object.

{  "ID": 1234,  "Name": "Acme Corp",  "CRMCustomerID": "CRM-12345",  "AccountID": "ACCT-001",  "Website": "https://acme.com",  "IsActive": true,  "IndustryID": 2,  "CustomerStatusID": 1,  "Division": "North America",  "Address1": "123 Main St",  "Address2": "Suite 400",  "City": "New York",  "Zip": "10001",  "CountryCode": "US",  "DateLastUpdated": "2025-09-30T10:22:30Z",  "UpdatedByUserID": 567,  "StateProvince": "NY",  "CustomerOption1ID": 101,  "CustomerOption2ID": 102,  "CustomerOption3ID": 103,  "SalesChannelLevel1ID": 1,  "SalesChannelLevel2ID": 2,  "CustomerLogoUrl": "https://cdn.example.com/logos/acme.png" }  

Error Responses

400 Bad Request

Validation errors for one or more fields.

{  "title": "Validation Failed",  "status": 400,  "errors": {    "Name": ["Name cannot exceed 1000 characters."],    "IndustryID": ["Invalid industry ID."]  } }  

401 Unauthorized

You are not authenticated to perform this action.

404 Not Found

No customer exists with the given CustomerID .

500 Internal Server Error

Unexpected error occurred.