Marketplace
Find-or-create customer + enrolment (no transaction)
Same identifier resolution + create-on-miss as
/marketplace/accrue, but without posting a transaction.
Used by checkout-time signup flows (Shopify customers/create,
Toast guest-create) where the partner wants the customer on
the loyalty programme but doesn’t have a purchase to credit
yet. Idempotent on (customer, card) — repeating the call
returns the same enrolment at HTTP 200.
This endpoint changes live customer data and therefore rejects test credentials with 403.
POST
https://dashboard.perkstar.co.uk/api/v1
/
marketplace
/
enroll
Find-or-create customer + enrolment (no transaction)
curl --request POST \
--url https://dashboard.perkstar.co.uk/api/v1/marketplace/enroll \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifier": {
"customer_id": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"external_ref": "<string>",
"card_serial": "<string>"
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identifier: {
customer_id: '<string>',
phone: '<string>',
email: 'jsmith@example.com',
external_ref: '<string>',
card_serial: '<string>'
}
})
};
fetch('https://dashboard.perkstar.co.uk/api/v1/marketplace/enroll', 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/marketplace/enroll"
payload = { "identifier": {
"customer_id": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"external_ref": "<string>",
"card_serial": "<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/marketplace/enroll",
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([
'identifier' => [
'customer_id' => '<string>',
'phone' => '<string>',
'email' => 'jsmith@example.com',
'external_ref' => '<string>',
'card_serial' => '<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;
}{
"customer": {
"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"
},
"enrollment": {
"id": "<string>",
"customer_id": "<string>",
"card_id": "<string>",
"status": "ACTIVE",
"balance": 123,
"redemptions_count": 123,
"cumulative_spend_pence": 123,
"bonus_points_balance": 123,
"enrolled_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z",
"wallet_passes": {
"apple": "<string>",
"google": "<string>"
}
},
"wallet_passes": {
"apple": "<string>",
"google": "<string>"
},
"customer_created": true,
"enrollment_created": true
}{
"customer": {
"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"
},
"enrollment": {
"id": "<string>",
"customer_id": "<string>",
"card_id": "<string>",
"status": "ACTIVE",
"balance": 123,
"redemptions_count": 123,
"cumulative_spend_pence": 123,
"bonus_points_balance": 123,
"enrolled_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z",
"wallet_passes": {
"apple": "<string>",
"google": "<string>"
}
},
"wallet_passes": {
"apple": "<string>",
"google": "<string>"
},
"customer_created": true,
"enrollment_created": true
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Replay-safe request key. Repeated requests with the same value within 24h return the original response unchanged.
Maximum string length:
255Body
application/json
Customer identifier block. At least ONE field must be present. Resolution order is fixed: customer_id → card_serial → external_ref → email → phone. First match wins.
Show child attributes
Show child attributes
Fields used when create_customer_if_missing is true and no existing customer matches the identifier.
Show child attributes
Show child attributes
Free-text marketing source ("shopify_checkout", "toast_guest_create"). Surfaced on the CUSTOMER_ENROLLED webhook payload.
Maximum string length:
60Was this page helpful?
⌘I
Find-or-create customer + enrolment (no transaction)
curl --request POST \
--url https://dashboard.perkstar.co.uk/api/v1/marketplace/enroll \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifier": {
"customer_id": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"external_ref": "<string>",
"card_serial": "<string>"
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identifier: {
customer_id: '<string>',
phone: '<string>',
email: 'jsmith@example.com',
external_ref: '<string>',
card_serial: '<string>'
}
})
};
fetch('https://dashboard.perkstar.co.uk/api/v1/marketplace/enroll', 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/marketplace/enroll"
payload = { "identifier": {
"customer_id": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"external_ref": "<string>",
"card_serial": "<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/marketplace/enroll",
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([
'identifier' => [
'customer_id' => '<string>',
'phone' => '<string>',
'email' => 'jsmith@example.com',
'external_ref' => '<string>',
'card_serial' => '<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;
}{
"customer": {
"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"
},
"enrollment": {
"id": "<string>",
"customer_id": "<string>",
"card_id": "<string>",
"status": "ACTIVE",
"balance": 123,
"redemptions_count": 123,
"cumulative_spend_pence": 123,
"bonus_points_balance": 123,
"enrolled_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z",
"wallet_passes": {
"apple": "<string>",
"google": "<string>"
}
},
"wallet_passes": {
"apple": "<string>",
"google": "<string>"
},
"customer_created": true,
"enrollment_created": true
}{
"customer": {
"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"
},
"enrollment": {
"id": "<string>",
"customer_id": "<string>",
"card_id": "<string>",
"status": "ACTIVE",
"balance": 123,
"redemptions_count": 123,
"cumulative_spend_pence": 123,
"bonus_points_balance": 123,
"enrolled_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z",
"wallet_passes": {
"apple": "<string>",
"google": "<string>"
}
},
"wallet_passes": {
"apple": "<string>",
"google": "<string>"
},
"customer_created": true,
"enrollment_created": true
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}