Skip to main content
POST
Add a customer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Body

application/json
customer_id
string
required

Your Customer ID

Example:

"123"

name
string
required

Customer name

Example:

"TATA RATAN"

phone
string

Phone number

Example:

"1234567890"

email
string

Email address

Example:

"reddi@reddi.reddi"

discount
integer

Discount

Example:

10

gstin
string

GSTIN

Pattern: ^(|[0-9A-Z]{15})$
Example:

"27AARCS7202C1ZD"

company_name
string

Company name

Example:

"GSTN"

opening_balance
string

Opening balance

Example:

"1245"

credit_limit
integer

Credit limit

Example:

200

billing_address
object[]

List of billing addresses

shipping_address
object[]

List of shipping addresses

opening_balance_type
integer

Credit[0] / Debit[1]

Example:

1

dial_code
string

Dial code

Example:

"91"

profile_image
string

Profile image URL

Example:

""

pan
string

PAN

Example:

"ABCD1234F"

notes
string

Notes

Example:

"Testing api"

cc_emails
string

CC email addresses

Example:

"reddi@reddi.reddi,acb.a@bcd.con"

status
string

Status

Example:

"Active"

Response

Success

success
boolean

Success flag

Example:

true

message
string

Response message

Example:

"Customer added successfully"