Skip to main content

Create Customer

POST /customers

Description

Create a new customer record.

Authentication

API Key (X-API-Key)

Request

Headers

HeaderValueRequired
X-API-Key{api_key}Yes

Request Body

{
"name": "Vusa Khoza",
"phone": "263773591219",
"email": "vusumuzi@qantra.co.zw",
"billingCurrencyString": "USD",
"companyIdString": "{{companyIdString}}"
}

Request Body Fields

FieldTypeRequiredDescription
namestringYesFull name of the customer
phonestringYesPhone number (e.g., 263773591219)
emailstringYesEmail address
billingCurrencyStringstringYesBilling currency code (e.g., USD)
companyIdStringstringYesUUID of the company this customer belongs to