ARK TMS

MCP documentation | MCP docs for agents

ark_update_customer

ark.update_customer

Update a visible ARK customer profile and optionally replace its visible team mappings.

Availability
Expanded preview
Scopes
customers:write
ARK permissions
canEditCustomer
Team visibility
Required and enforced
Approval policy
ask_before_write
ARK approval request
Required before execution
Idempotency
Required for external execution
Read-only
No
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

customerIdstringrequired

Visible ARK customer ID.

format: uuid

namestring

Customer name.

min length: 2; max length: 200

codestring | null

Optional customer code.

max length: 50

typestring | null

Optional customer type.

max length: 50

countrystring

one of: USA, CAN, MEX; default: "USA"

defaultCurrencystring

one of: USD, CAD, MXN; default: "USD"

trackingEmailstring | null

Tracking email or delimited email list.

max length: 500

notesstring | null

max length: 5000

businessHoursOpenstring | null

max length: 50

businessHoursClosestring | null

max length: 50

paymentTermIdstring | null

Optional payment term ID.

format: uuid

defaultInvoiceRemitProfileIdstring | null

Optional customer-specific invoice remit profile ID. Use null to inherit the organization default.

format: uuid

Result

The tool returns the canonical ark.update_customer operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.