curl --request POST \
--url https://api.zenskar.com/customers \
--header 'Content-Type: application/json' \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"customer_name": "Acme Corporation",
"email": "billing@acme.com"
}
'{
"id": "123e4567-e89b-12d3-a456-426614174000",
"customer_name": "Acme Corporation",
"email": "billing@acme.com",
"phone_number": "+1-555-0100",
"address": {
"line1": "123 Business Ave",
"city": "San Francisco",
"state": "CA",
"zipCode": "94102",
"country": "United States",
"country_code": "US",
"validation_status": "valid"
},
"tax_info": [],
"custom_data": {
"industry": "Technology",
"company_size": "50-200"
},
"communications_enabled": true,
"auto_charge_enabled": true
}Create customer
Creates a new customer object in Zenskar. Customer objects represent the individuals or companies you do business with and serve for your revenue operations—they must exist before you can create contracts, generate invoices, or process payments.
The customer record stores essential billing information including contact details, billing and shipping addresses, tax identifiers, payment preferences, and custom metadata specific to your business needs. Only customer_name is required at creation—all other fields are optional, allowing you to capture minimal information initially. The customer address is an important field which is used for Regional tax calculation, make sure this field is correct for the required customers.
When integrated with external systems, newly created customers are automatically synchronized with configured platforms like Stripe, HubSpot, Zoho, or Xero. Use the external_id field to maintain references to source systems for bidirectional synchronization.
curl --request POST \
--url https://api.zenskar.com/customers \
--header 'Content-Type: application/json' \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"customer_name": "Acme Corporation",
"email": "billing@acme.com"
}
'{
"id": "123e4567-e89b-12d3-a456-426614174000",
"customer_name": "Acme Corporation",
"email": "billing@acme.com",
"phone_number": "+1-555-0100",
"address": {
"line1": "123 Business Ave",
"city": "San Francisco",
"state": "CA",
"zipCode": "94102",
"country": "United States",
"country_code": "US",
"validation_status": "valid"
},
"tax_info": [],
"custom_data": {
"industry": "Technology",
"company_size": "50-200"
},
"communications_enabled": true,
"auto_charge_enabled": true
}Authorizations
Body
Create Customer Request Schema
Full name of the customer or company
External identifier for this customer from your system or third-party CRM (e.g., Salesforce ID)
255Custom key-value pairs for storing additional customer information (e.g., industry, account tier, sales rep)
Primary billing address for the customer
Show child attributes
Show child attributes
Shipping address if different from billing address
Show child attributes
Show child attributes
List of tax identifiers for the customer (e.g., VAT number, GST number)
Show child attributes
Show child attributes
Primary email address for the customer (must be unique within organization)
Primary phone number for the customer (include country code, e.g., +1-555-0100)
External connector information for integration with third-party systems
Show child attributes
Show child attributes
Enable or disable email communications for this customer (invoices, receipts, etc.)
Enable or disable automatic payment charging for invoices
Business entity ID to associate with this customer
Response
Successfully created customer
Create Customer Response Schema
Customer Id
External Customer Id
Customer name
Customer Custom Data
Customer Address
Show child attributes
Show child attributes
Customer Ship To Address
Show child attributes
Show child attributes
Customer Tax Ids
Show child attributes
Show child attributes
Customer primary email address
Customer Tags
Customer Phone Number
To enable/disable communications
To enable/disable auto-charge
Business Entity Id