Customer Enrollment & Profile
Update customer birth date
Updates or sets a customer’s birth date in the loyalty system. Used for birthday reward programs and customer segmentation. Send customerId and dob (YYYY-MM-DD). If you only know the month and day, send any year and set dobYearProvided to false. dob is required. When dobYearProvided isn’t false, the year must be 1900 or later and the date can’t be in the future. Invalid requests return 400 and leave the stored birth date unchanged. If the customer’s birthday is today, any applicable birthday earn rule awards points right away.
PUT
/
api
/
external
/
update-customer-birth-date
Update customer birth date
curl --request PUT \
--url https://loyalty-admin.appstle.com/api/external/update-customer-birth-date \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"customerId": 0,
"dob": "2026-01-12",
"dobYearProvided": true,
"status": "ACTIVE"
}
'import requests
url = "https://loyalty-admin.appstle.com/api/external/update-customer-birth-date"
payload = {
"customerId": 0,
"dob": "2026-01-12",
"dobYearProvided": True,
"status": "ACTIVE"
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({customerId: 0, dob: '2026-01-12', dobYearProvided: true, status: 'ACTIVE'})
};
fetch('https://loyalty-admin.appstle.com/api/external/update-customer-birth-date', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://loyalty-admin.appstle.com/api/external/update-customer-birth-date';
const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({customerId: 0, dob: '2026-01-12', dobYearProvided: true, status: 'ACTIVE'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://loyalty-admin.appstle.com/api/external/update-customer-birth-date",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'customerId' => 0,
'dob' => '2026-01-12',
'dobYearProvided' => true,
'status' => 'ACTIVE'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://loyalty-admin.appstle.com/api/external/update-customer-birth-date"
payload := strings.NewReader("{\n \"customerId\": 0,\n \"dob\": \"2026-01-12\",\n \"dobYearProvided\": true,\n \"status\": \"ACTIVE\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://loyalty-admin.appstle.com/api/external/update-customer-birth-date")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": 0,\n \"dob\": \"2026-01-12\",\n \"dobYearProvided\": true,\n \"status\": \"ACTIVE\"\n}"
response = http.request(request)
puts response.read_body{
"availablePoints": 123,
"createAt": "2023-11-07T05:31:56Z",
"customerId": 123,
"pendingPoints": 123,
"shop": "<string>",
"availableStoreCredits": 123,
"displayName": "<string>",
"dob": "2023-12-25",
"dobYearProvided": true,
"email": "<string>",
"emailBouncedOrFailed": true,
"emailSetting": "<string>",
"enableEmail": true,
"enableEmailMarketing": true,
"enableSmsMarketing": true,
"firstName": "<string>",
"id": 123,
"isDeletedFromShopify": true,
"lastActivity": "2023-11-07T05:31:56Z",
"lastMonthlyReminderSentDate": "2023-11-07T05:31:56Z",
"lastName": "<string>",
"lastRewardExpiryReminderSentDate": "2023-11-07T05:31:56Z",
"loyaltyProgramEnabled": true,
"ordersCount": 123,
"phone": "<string>",
"redeemLimit": 123,
"redeemLimitOnce": 123,
"redeemedPoints": 123,
"skipReview": true,
"spentAmount": 123,
"status": "ACTIVE",
"storeCreditAccountId": "<string>",
"tags": "<string>",
"token": "<string>",
"updatedSettings": "<string>",
"vipAssignType": "MANUAL",
"vipTier": "<string>",
"vipTierAmount": 123,
"vipTierExpiredAt": "2023-11-07T05:31:56Z",
"vipTierId": 123,
"vipTierOrderCount": 123,
"vipTierSummary": "<string>"
}Body
application/json
Request containing customer ID and birth date
Response
Customer birth date successfully updated
⌘I
Update customer birth date
curl --request PUT \
--url https://loyalty-admin.appstle.com/api/external/update-customer-birth-date \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"customerId": 0,
"dob": "2026-01-12",
"dobYearProvided": true,
"status": "ACTIVE"
}
'import requests
url = "https://loyalty-admin.appstle.com/api/external/update-customer-birth-date"
payload = {
"customerId": 0,
"dob": "2026-01-12",
"dobYearProvided": True,
"status": "ACTIVE"
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({customerId: 0, dob: '2026-01-12', dobYearProvided: true, status: 'ACTIVE'})
};
fetch('https://loyalty-admin.appstle.com/api/external/update-customer-birth-date', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://loyalty-admin.appstle.com/api/external/update-customer-birth-date';
const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({customerId: 0, dob: '2026-01-12', dobYearProvided: true, status: 'ACTIVE'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://loyalty-admin.appstle.com/api/external/update-customer-birth-date",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'customerId' => 0,
'dob' => '2026-01-12',
'dobYearProvided' => true,
'status' => 'ACTIVE'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://loyalty-admin.appstle.com/api/external/update-customer-birth-date"
payload := strings.NewReader("{\n \"customerId\": 0,\n \"dob\": \"2026-01-12\",\n \"dobYearProvided\": true,\n \"status\": \"ACTIVE\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://loyalty-admin.appstle.com/api/external/update-customer-birth-date")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": 0,\n \"dob\": \"2026-01-12\",\n \"dobYearProvided\": true,\n \"status\": \"ACTIVE\"\n}"
response = http.request(request)
puts response.read_body{
"availablePoints": 123,
"createAt": "2023-11-07T05:31:56Z",
"customerId": 123,
"pendingPoints": 123,
"shop": "<string>",
"availableStoreCredits": 123,
"displayName": "<string>",
"dob": "2023-12-25",
"dobYearProvided": true,
"email": "<string>",
"emailBouncedOrFailed": true,
"emailSetting": "<string>",
"enableEmail": true,
"enableEmailMarketing": true,
"enableSmsMarketing": true,
"firstName": "<string>",
"id": 123,
"isDeletedFromShopify": true,
"lastActivity": "2023-11-07T05:31:56Z",
"lastMonthlyReminderSentDate": "2023-11-07T05:31:56Z",
"lastName": "<string>",
"lastRewardExpiryReminderSentDate": "2023-11-07T05:31:56Z",
"loyaltyProgramEnabled": true,
"ordersCount": 123,
"phone": "<string>",
"redeemLimit": 123,
"redeemLimitOnce": 123,
"redeemedPoints": 123,
"skipReview": true,
"spentAmount": 123,
"status": "ACTIVE",
"storeCreditAccountId": "<string>",
"tags": "<string>",
"token": "<string>",
"updatedSettings": "<string>",
"vipAssignType": "MANUAL",
"vipTier": "<string>",
"vipTierAmount": 123,
"vipTierExpiredAt": "2023-11-07T05:31:56Z",
"vipTierId": 123,
"vipTierOrderCount": 123,
"vipTierSummary": "<string>"
}