Request
Curl
Response
Success
Parameters
name optional
: string Customer’s name. Alphanumeric value with period (.), apostrophe (’), forward slash (/), at (@) and parentheses are allowed. The name must be between 3-50 characters in length. For example, Gaurav Kumar.
contact optional
: string The customer’s phone number. A maximum length of 15 characters including country code. For example, +919876543210.
email optional
: string The customer’s email address. A maximum length of 64 characters. For example, gaurav.kumar@example.com.
fail_existing optional
: string Possible values:
1(default): If a customer with the same details already exists, throws an error.0: If a customer with the same details already exists, fetches details of the existing customer.
gstin optional
: string Customer’s GST number, if available. For example, 29XAbbA4369J1PA.
notes optional
: object This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.
Parameters
id
: string Unique identifier of the customer. For example, cust_1Aa00000000004.
entity optional
: string Indicates the type of entity.
name
: string Customer’s name. Alphanumeric, with period (.), apostrophe (’), forward slash (/), at (@) and parentheses allowed. The name must be between 3-50 characters in length.
contact
: string The customer’s phone number. A maximum length of 15 characters including country code.
email
: string The customer’s email address. A maximum length of 64 characters.
gstin
: string GST number linked to the customer. For example, 29XAbbA4369J1PA.
notes
: json object This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.
created_at
: integer UNIX timestamp, when the customer was created. For example, 1234567890.
Errors
The API “ provided is invalid.- code: 4xx
- description: The API credentials passed in the API call differ from the ones generated on the Dashboard. Possible reasons: - Different keys for test mode and live modes.
- Expired API key.
- solution: The API keys must be active and entered correctly with no whitespace before or after the keys.
- code: 400
- description: The contact number is less than 8 digits.
- solution: Enter contact number that meets the validation criteria. It should have at least 8 digits, including the country code. For example, “+919876543210”.