Skip to main content
POST
/
customers
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
}

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
default:<your-api-key>
required
​
organisation
string
header
default:<your-organisation-id>
required

Body

application/json

Create Customer Request Schema

​
customer_name
string
default:Acme Corporation
required

Full name of the customer or company

​
external_id
string | null

External identifier for this customer from your system or third-party CRM (e.g., Salesforce ID)

Maximum string length: 255
​
custom_data
Custom Data · object

Custom key-value pairs for storing additional customer information (e.g., industry, account tier, sales rep)

​
address
Address · object

Primary billing address for the customer

​
ship_to_address
Address · object

Shipping address if different from billing address

​
tax_info
TaxId · object[] | null

List of tax identifiers for the customer (e.g., VAT number, GST number)

​
email
string<email> | null

Primary email address for the customer (must be unique within organization)

​
phone_number
string | null

Primary phone number for the customer (include country code, e.g., +1-555-0100)

​
connector
Connector · object

External connector information for integration with third-party systems

​
communications_enabled
boolean | null

Enable or disable email communications for this customer (invoices, receipts, etc.)

​
auto_charge_enabled
boolean | null

Enable or disable automatic payment charging for invoices

​
business_entity_id
string<uuid> | null

Business entity ID to associate with this customer

Response

Successfully created customer

Create Customer Response Schema

​
id
string<uuid>
required

Customer Id

​
external_id
string | null
required

External Customer Id

​
customer_name
string
required

Customer name

​
custom_data
Custom Data · object
required

Customer Custom Data

​
address
AddressResponse · object
required

Customer Address

​
ship_to_address
AddressResponse · object

Customer Ship To Address

​
tax_info
TaxId · object[] | null

Customer Tax Ids

​
email
string | null

Customer primary email address

​
custom_attributes
Custom Attributes · object

Customer Tags

​
phone_number
string | null

Customer Phone Number

​
communications_enabled
boolean | null
default:true

To enable/disable communications

​
auto_charge_enabled
boolean | null
default:true

To enable/disable auto-charge

​
business_entity_id
string<uuid> | null

Business Entity Id