Kimai icon

Kimai

Interact with Kimai time-tracking API

Customer → Update

AI-generated

Summary

Updates a Kimai customer with the supplied identifier and optional fields.

Inputs

  • id (required) — Unique identifier of the customer to update.
  • name (required) — Customer's name.
  • number — Customer's internal number.
  • comment — General comment about the customer.
  • company — Company name associated with the customer.
  • vatId — Customer's VAT identification number.
  • contact — Primary contact person or email.
  • addressLine1 — First line of the customer's address.
  • addressLine2 — Second line of the customer's address.
  • addressLine3 — Third line of the customer's address.
  • postcode — Postal code of the customer's address.
  • city — City of the customer's address.
  • country — Country of the customer's address.
  • currency — Preferred currency for invoices.
  • phone — Phone number.
  • fax — Fax number.
  • mobile — Mobile phone number.
  • email — Email address.
  • homepage — Customer's homepage URL.
  • timezone — Timezone identifier.
  • invoiceText — Custom invoice text.
  • invoiceTemplate — Invoice template identifier.
  • buyerReference — Reference used by the buyer.
  • color — Preferred color for UI representation.
  • visible — Visibility status (true for visible).
  • billable — Whether the customer is billable.
  • requestOptions — Advanced HTTP request settings such as batching, SSL verification, proxy, and timeout.

Output shape

a single updated customer object

Returns the updated customer record; all fields are present, but only those provided are modified.

Examples

Example 1: Update customer name and email

id=123, name=Acme Corp, email=info@acme.com

Example 2: Deactivate a customer

id=456, visible=false

Discussion