Customer.Update

Try it in Swagger

Endpoint

Updates a customer/account's editable profile fields. Account administrators may update accounts in their allowed set (their own account plus bill-to accounts in AdditionalWebAccess). Master contacts (configured MasterContactCode for the tenant, with API key) may update any account. Only editable profile fields are changed; financial, payment, billing-terms, and internal accounting fields are never modified.

Request Schema

Headers

Header Required Notes
X-Api-Key Required when tenant is not resolved by subdomain Resolves the tenant/customer database. Also required for master-contact elevation.
Authorization: Bearer {token} Required for authorized endpoints Get a token from Auth/Token or Session/Create.

Path Parameters

Field Type Required Notes
customerCode string Yes Customer code of the account to update.

JSON Body

Body type: CustomerWriteRequestDto (same editable fields as Create, without customerCode).

Financial, payment, billing-terms, and internal accounting fields cannot be modified through this endpoint.

Request Sample

{
  "name": "Acme Law Group",
  "fullName": "Acme Law Group LLP",
  "attention": "Accounts Payable",
  "address1": "123 Main St",
  "suite": "500",
  "city": "Los Angeles",
  "state": "CA",
  "zip": "90017",
  "phone": "2135550100",
  "fax": "2135550101",
  "email": "ap@acmelaw.example.com"
}

Expected Response Schema

Status Codes

Status Notes
200 OK Account updated; the updated account is returned.
400 Bad Request Validation failed (missing name or invalid email).
403 Forbidden Caller is not an administrator / master contact, or the account is outside the caller's allowed set.
404 Not Found No account with that code exists.

Success Body

Response type: CustomerLookupDto (see Get for fields).