Create Customer
Create a new customer record in COUNT. This endpoint supports creating a customer with full details including addresses and contacts in a single request.
Required Fields:
customer(name): 1-255 characters, non-emptyemail: Valid email format, must be unique within your team
Email Uniqueness:
Customer emails must be unique within a team. Always use the find-by-email endpoint first to check if a customer exists before creating to avoid 409 Conflict errors.
Contact Creation:
- Contacts are created atomically with the customer
- If contact validation fails, the entire customer creation fails
- Only one contact should be marked as
isPrimary: true
Address Flexibility: Addresses are optional and flexible:
- Can omit addresses entirely
- Can provide partial addresses
- Can provide complete addresses
Status Default:
If you don't specify status, it defaults to "active". Most integrations should use "active" for new customers.
UUID Generation:
The uuid field is auto-generated by COUNT and returned in the response. Store this UUID for future operations.
Timestamps:
createdAt and updatedAt are automatically set to the current time when the customer is created.
Use Cases:
- Create customers from your CRM
- Create customers automatically when orders are placed
- Import customers from external systems
- User registration flows
Header Parameters
Body Parameters
Customer or business name (1-255 characters, non-empty)
Primary contact email (must be unique within team)
Primary phone number (max 50 characters, international format recommended)
Website URL (max 255 characters, should include protocol)
Customer status (defaults to "active" if not specified)
activeinactiveAddress structure for billing and shipping addresses
Show child attributes
Address structure for billing and shipping addresses
Show child attributes
Contact persons (optional, array of contact objects)
Show child attributes
Response
Response Attributes
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
What made this section unhelpful for you?
Response
What made this section unhelpful for you?