Customers

Update a business customer

Updates an existing customer record identified by its DigiTax customer ID.

put/customers/{customer_id}

Request

  • Base URL
    https://api.digitax.tech/ke/v2
  • Auth
    API key in header X-API-Key

Path parameters

customer_idstring required

Customer ID on DigiTax

Example:customer_01HC3J1VVVM05YCTS61G7V3KC6

The DigiTax ID of the customer to update.

Request body

customer_namestring required

The customer's name. This field is required; send an empty string to keep the current name.

emailstring

The customer's email address. Leave unset to keep the current email address.

phonestring

The customer's phone number. Leave unset to keep the current phone number.

Example request

{
  "customer_name": "John Doe",
  "email": "john@doe.com"
}

Response

Success

idstring required

The DigiTax ID of the customer.

customer_namestring required

The customer's name.

emailstring

The customer's email address.

phonestring

The customer's phone number.

customer_tinstring required

The customer's Tax Identification Number (TIN).

taxpayer_type'INDIVIDUAL' | 'BUSINESS' required

The taxpayer type, derived from the TIN prefix - P is BUSINESS, all other prefixes are INDIVIDUAL.

Example response

{
  "id": "customer_01HC3HTDAXQ50E07CWR2A2CFBD",
  "customer_name": "John Doe",
  "email": "john@doe.com",
  "customer_tin": "P012345678P",
  "taxpayer_type": "INDIVIDUAL"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.