v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Customers

Update a customer

Update a customer's name, email, or contact. The combination of email and contact must remain unique. Contact number must contain at least 8 digits.

put/customers/{id}

idstring required

Customer ID (cust_*).

namestring

Updated name. 3-50 characters.

contactstring

Updated phone number. Min 8 digits including country code.

emailstring

Updated email. Max 64 characters.

Updated customer.

idstring

Unique customer identifier. Prefix: cust_

entity'customer'

namestring

Customer name. 3-50 characters. Allowed: alphanumeric, period, apostrophe, forward slash, @, parentheses.

contactstring

Phone number. Max 15 characters. Include country code (e.g. +919876543210). Minimum 8 digits.

emailstring

Email address. Max 64 characters.

gstinstring

Goods and Services Tax Identification Number (optional).

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

created_atinteger

Unix timestamp of customer creation.