Skip to main content
POST
/
v1
/
customers
Create customer
curl --request POST \
  --url https://api.shingleai.com/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "notes": "<string>",
  "status": "<string>",
  "customerSince": "2023-11-07T05:31:56Z",
  "data": {}
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "notes": "<string>",
    "status": "<string>",
    "customerSince": "2023-11-07T05:31:56Z",
    "data": {}
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication via Bearer token

Body

application/json
​
businessId
string<uuid>
required
​
type
string
required
​
contactId
string<uuid> | null
​
name
string | null
​
email
string | null
​
phone
string | null
​
notes
string | null
​
status
string | null
​
customerSince
string<date-time> | null
​
data
object

Response

Customer created successfully

​
data
object
required
​
meta
object