Skip to main content
POST
/
v1
/
clients
Create client
curl --request POST \
  --url https://app.blinksale.test/api/v1/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Inc",
  "email": "[email protected]",
  "kind": "BUSINESS",
  "profile": {
    "company_name": "Acme Inc",
    "website": "https://acme.com"
  },
  "document_defaults": {
    "currency": "USD"
  },
  "address": {
    "line1": "123 Main St",
    "line2": "Suite 101",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94107",
    "country": "US"
  },
  "contacts": [
    {
      "name": "Jane Smith",
      "email": "[email protected]",
      "phone": "+14155552671"
    }
  ]
}
'
{
  "success": true,
  "message": "Client created successfully",
  "data": {
    "id": "01jtbf0c9zaraqx3swthf88n5y",
    "name": "Acme Inc",
    "email": "[email protected]",
    "kind": "BUSINESS",
    "kind_name": "Business",
    "profile": {
      "company_name": "Acme Inc",
      "website": "https://acme.com"
    },
    "address": {
      "line1": "123 Main St",
      "line2": "Suite 101",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94107",
      "country": "US"
    },
    "document_defaults": {
      "currency": "USD"
    },
    "contact_count": 3,
    "note_count": 2,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Access token obtained from the /v1/auth/login endpoint

Body

application/json
​
name
string
required
Example:

"Acme Inc"

​
email
string<email>
required
​
kind
enum<string>
default:BUSINESS
Available options:
BUSINESS,
PERSON
​
profile
object
​
document_defaults
object
​
address
object
​
contacts
object[]

Response

Client created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Client created successfully"

​
data
object