post https://api.zenskar.com/customer
Body parameters
| Param | Description |
|---|---|
external_id | The customer identifier you use in your system. This identifier is termed as external ID in Zenskar. |
customer_name | Name of the customer. |
custom_data | Any custom data that you would like to store. |
address | Address of the customer. |
email | Email of the customer. |
phone_number | Phone number of the customer with country code. |
connector | • name of the connector in small letters. For example, stripe, xero, salesforce, hubspot etc.• reference_id is connector specific. Refer the documentation of the corresponding third-party software for more information. Contact [email protected] for assistance. |
Details of external ID
An external ID can be provided in the GUI while:
- adding a new customer
- editing customer details
The external_id corresponds to External ID field in the GUI.
Note
- If you use a UUID as customer identifier in your system and plan to use the same identifier in Zenskar, sending the UUID as
external_idin the API request will enable Zenskar to use that UUID as an identifier.- If you use a non-UUID customer identifier in your system and plan to use the same identifier in Zenskar, you can send such an identifier in as
external_idin the API request. Zenskar will create an internal UUID-based identifier and use your non-UUID customer identifier as external ID.- If you send an empty string in the API request, Zenskar will create a UUID-based internal ID and no external ID will exist in Zenskar.
Custom data
An example usage for custom data is to specify a parent_customer_id and set invoice_consolidation_enabled as true to enable the consolidated invoice feature.
{
"parent_customer_id": "1ba67a0d-1373-4e5a-bd6f-3ab313500e15",
"invoice_consolidation_enabled": "true"
}