Skip to main content
POST
/
customers
Create Customer
curl --request POST \
  --url https://{primary_domain}/api/public/v2.0/customers \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key-Id: <api-key>' \
  --header 'X-Access-Key-Secret: <api-key>' \
  --data '
{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "contact_number": "<string>",
  "address": {
    "line_1": "<string>",
    "line_2": "<string>",
    "city": "<string>",
    "region": "<string>",
    "region_code": "<string>",
    "country": "<string>",
    "country_code": "<string>",
    "postal_code": "<string>"
  }
}
'
{
  "message": "<string>",
  "data": {
    "id": 123,
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "contact_number": "<string>",
    "address": {
      "line_1": "<string>",
      "line_2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "region_code": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "postal_code": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-Access-Key-Id
string
header
required
​
X-Access-Key-Secret
string
header
required

Body

application/json
​
first_name
string | null
required
Maximum string length: 255
​
middle_name
string | null
required
Maximum string length: 255
​
last_name
string | null
required
Maximum string length: 255
​
email
string<email> | null
required
Maximum string length: 255
​
contact_number
string | null
required

In E.164 format.

​
address
object | null
required

Response

​
message
string
required
​
data
object
required

A Customer resource object.