Customers

Create or upsert a customer

When external_ref is supplied, the endpoint upserts on the unique (orgId, externalRef) key: • Existing match → returns the existing record with HTTP 200. No fields are overwritten. • No match → creates a new customer, HTTP 201.

Without external_ref, the endpoint always creates and returns HTTP 201 (or 409 if the supplied email already exists in the org). Idempotency-Key remains the 24h replay cache; the externalRef upsert is the permanent semantic dedupe.

POST

https://dashboard.perkstar.co.uk/api/v1

customers

Create or upsert a customer

curl --request POST \
  --url https://dashboard.perkstar.co.uk/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-11-07T05:31:56Z",
  "consent_marketing": true,
  "consent_ad_tracking": true,
  "external_ref": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'jsmith@example.com',
    phone: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    date_of_birth: '2023-11-07T05:31:56Z',
    consent_marketing: true,
    consent_ad_tracking: true,
    external_ref: '<string>'
  })
};

fetch('https://dashboard.perkstar.co.uk/api/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dashboard.perkstar.co.uk/api/v1/customers"

payload = {
    "email": "jsmith@example.com",
    "phone": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-11-07T05:31:56Z",
    "consent_marketing": True,
    "consent_ad_tracking": True,
    "external_ref": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dashboard.perkstar.co.uk/api/v1/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jsmith@example.com',
    'phone' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'date_of_birth' => '2023-11-07T05:31:56Z',
    'consent_marketing' => true,
    'consent_ad_tracking' => true,
    'external_ref' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "<string>",
  "customer_number": 123,
  "email": "<string>",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-11-07T05:31:56Z",
  "consent_marketing": true,
  "consent_ad_tracking": true,
  "external_ref": "<string>",
  "anonymized_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "id": "<string>",
  "customer_number": 123,
  "email": "<string>",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-11-07T05:31:56Z",
  "consent_marketing": true,
  "consent_ad_tracking": true,
  "external_ref": "<string>",
  "anonymized_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

Replay-safe request key. Repeated requests with the same value within 24h return the original response unchanged.

Maximum string length: 255

Body

application/json

string<email>

phone

string

first_name

string

last_name

string

date_of_birth

string<date-time>

external_ref

string

Response

Existing customer returned (externalRef upsert hit)

string

customer_number

integer

string | null

phone

string | null

first_name

string | null

last_name

string | null

date_of_birth

string<date-time> | null

external_ref

string | null

Partner-supplied identifier (Shopify customer GID, Toast guest UUID, Square customer id, …). Unique per org. POST /customers upserts on this when supplied.

anonymized_at

string<date-time> | null

deleted_at

string<date-time> | null

created_at

string<date-time>

updated_at

string<date-time>

List customers

Get a customer

⌘I

Create or upsert a customer

curl --request POST \
  --url https://dashboard.perkstar.co.uk/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-11-07T05:31:56Z",
  "consent_marketing": true,
  "consent_ad_tracking": true,
  "external_ref": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'jsmith@example.com',
    phone: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    date_of_birth: '2023-11-07T05:31:56Z',
    consent_marketing: true,
    consent_ad_tracking: true,
    external_ref: '<string>'
  })
};

fetch('https://dashboard.perkstar.co.uk/api/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dashboard.perkstar.co.uk/api/v1/customers"

payload = {
    "email": "jsmith@example.com",
    "phone": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-11-07T05:31:56Z",
    "consent_marketing": True,
    "consent_ad_tracking": True,
    "external_ref": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dashboard.perkstar.co.uk/api/v1/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jsmith@example.com',
    'phone' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'date_of_birth' => '2023-11-07T05:31:56Z',
    'consent_marketing' => true,
    'consent_ad_tracking' => true,
    'external_ref' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "<string>",
  "customer_number": 123,
  "email": "<string>",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-11-07T05:31:56Z",
  "consent_marketing": true,
  "consent_ad_tracking": true,
  "external_ref": "<string>",
  "anonymized_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "id": "<string>",
  "customer_number": 123,
  "email": "<string>",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-11-07T05:31:56Z",
  "consent_marketing": true,
  "consent_ad_tracking": true,
  "external_ref": "<string>",
  "anonymized_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>"
  }
}

Customers

Enrollments

Transactions

Cards

Webhooks

Locations

Pushes

Marketplace

Create or upsert a customer

Authorizations

Headers

Body

Response