Getting Started

Sections

Theme switcher

Add Customer

Header Parameters

x-client-idstring
x-signaturestring
Authorizationstring
x-timestampstring
Content-Typestring

Body Parameters

customerstring Required

Customer or business name (1-255 characters, non-empty)

Min length
1
Max length
255
emailstring Required

Primary contact email (must be unique within team)

Max length
255
mainPhonestring

Primary phone number (max 50 characters, international format recommended)

Max length
50
Nullable:
True
websitestring

Website URL (max 255 characters, should include protocol)

Max length
255
Nullable:
True
statusstring

Customer status (defaults to "active" if not specified)

Enum values:
activeinactive
billingAddressobject

Address structure for billing and shipping addresses

Nullable:
True

Show child attributes

shippingAddressobject

Address structure for billing and shipping addresses

Nullable:
True

Show child attributes

contactsarray

Contact persons (optional, array of contact objects)

Show child attributes

Response

201
Object
Customer created successfully

Response Attributes

statusstring
messagestring
dataobject

Show child attributes

400
Object
Bad Request - Validation failed

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

401
Object
Unauthorized - Authentication failed

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

409
Object
Conflict - Email already exists

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

429
Object
Too Many Requests - Rate limit exceeded

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot