Create a loyalty program event
Create a loyalty program event
curl --request POST \
--url https://api.yorlet.com/v1/loyalty/program_events \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"loyalty_program": "<string>",
"recipient": {
"type": "customer",
"customer": "<string>"
},
"expires_at": 123,
"loyalty_program_override": {
"points": 123
},
"statement_descriptor": "<string>",
"identifier": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/loyalty/program_events"
payload = {
"loyalty_program": "<string>",
"recipient": {
"type": "customer",
"customer": "<string>"
},
"expires_at": 123,
"loyalty_program_override": { "points": 123 },
"statement_descriptor": "<string>",
"identifier": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
loyalty_program: '<string>',
recipient: {type: 'customer', customer: '<string>'},
expires_at: 123,
loyalty_program_override: {points: 123},
statement_descriptor: '<string>',
identifier: '<string>'
})
};
fetch('https://api.yorlet.com/v1/loyalty/program_events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/loyalty/program_events",
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([
'loyalty_program' => '<string>',
'recipient' => [
'type' => 'customer',
'customer' => '<string>'
],
'expires_at' => 123,
'loyalty_program_override' => [
'points' => 123
],
'statement_descriptor' => '<string>',
'identifier' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.yorlet.com/v1/loyalty/program_events"
payload := strings.NewReader("{\n \"loyalty_program\": \"<string>\",\n \"recipient\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"expires_at\": 123,\n \"loyalty_program_override\": {\n \"points\": 123\n },\n \"statement_descriptor\": \"<string>\",\n \"identifier\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/loyalty/program_events")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"loyalty_program\": \"<string>\",\n \"recipient\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"expires_at\": 123,\n \"loyalty_program_override\": {\n \"points\": 123\n },\n \"statement_descriptor\": \"<string>\",\n \"identifier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/loyalty/program_events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"loyalty_program\": \"<string>\",\n \"recipient\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"expires_at\": 123,\n \"loyalty_program_override\": {\n \"points\": 123\n },\n \"statement_descriptor\": \"<string>\",\n \"identifier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "loyalty.program_event",
"identifier": "<string>",
"expires_at": 123,
"loyalty_program": "<string>",
"loyalty_program_override": {
"points": 123
},
"recipient": {
"type": "customer",
"customer": "<string>"
},
"statement_descriptor": "<string>",
"status": "canceled",
"value": 123,
"account": "<string>",
"deleted": false,
"earn_rate": {
"spend_amount": 123
}
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The loyalty program ID.
The recipient of the loyalty program event.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Spend details used to calculate points earned for an earn-rate reward.
Show child attributes
Show child attributes
The date and time the points expire.
The number of points to award. If provided, this will override the default points set on the loyalty program.
Show child attributes
Show child attributes
The statement descriptor. This appears on the customer's statement. If provided, this overrides the statement descriptor set on the loyalty program.
A unique identifier for this grant on the programme, such as an order id. Creating another event with the same identifier on the same programme returns the original event.
1 - 255Response
Create a loyalty program event
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
loyalty.program_event A unique identifier for this grant on the programme, such as an order id. Creating another event with the same identifier on the same programme returns the original event.
The date and time the points expire.
The loyalty program ID.
The number of points to award. If provided, this will override the default points set on the loyalty program.
Show child attributes
Show child attributes
The recipient of the loyalty program event.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
The statement descriptor. This appears on the customer's statement. If provided, this overrides the statement descriptor set on the loyalty program.
The status of the event.
canceled, expired, pending, succeeded The points value of the event.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Spend details used to calculate points earned for an earn-rate reward.
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.yorlet.com/v1/loyalty/program_events \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"loyalty_program": "<string>",
"recipient": {
"type": "customer",
"customer": "<string>"
},
"expires_at": 123,
"loyalty_program_override": {
"points": 123
},
"statement_descriptor": "<string>",
"identifier": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/loyalty/program_events"
payload = {
"loyalty_program": "<string>",
"recipient": {
"type": "customer",
"customer": "<string>"
},
"expires_at": 123,
"loyalty_program_override": { "points": 123 },
"statement_descriptor": "<string>",
"identifier": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
loyalty_program: '<string>',
recipient: {type: 'customer', customer: '<string>'},
expires_at: 123,
loyalty_program_override: {points: 123},
statement_descriptor: '<string>',
identifier: '<string>'
})
};
fetch('https://api.yorlet.com/v1/loyalty/program_events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/loyalty/program_events",
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([
'loyalty_program' => '<string>',
'recipient' => [
'type' => 'customer',
'customer' => '<string>'
],
'expires_at' => 123,
'loyalty_program_override' => [
'points' => 123
],
'statement_descriptor' => '<string>',
'identifier' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.yorlet.com/v1/loyalty/program_events"
payload := strings.NewReader("{\n \"loyalty_program\": \"<string>\",\n \"recipient\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"expires_at\": 123,\n \"loyalty_program_override\": {\n \"points\": 123\n },\n \"statement_descriptor\": \"<string>\",\n \"identifier\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/loyalty/program_events")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"loyalty_program\": \"<string>\",\n \"recipient\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"expires_at\": 123,\n \"loyalty_program_override\": {\n \"points\": 123\n },\n \"statement_descriptor\": \"<string>\",\n \"identifier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/loyalty/program_events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"loyalty_program\": \"<string>\",\n \"recipient\": {\n \"type\": \"customer\",\n \"customer\": \"<string>\"\n },\n \"expires_at\": 123,\n \"loyalty_program_override\": {\n \"points\": 123\n },\n \"statement_descriptor\": \"<string>\",\n \"identifier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "loyalty.program_event",
"identifier": "<string>",
"expires_at": 123,
"loyalty_program": "<string>",
"loyalty_program_override": {
"points": 123
},
"recipient": {
"type": "customer",
"customer": "<string>"
},
"statement_descriptor": "<string>",
"status": "canceled",
"value": 123,
"account": "<string>",
"deleted": false,
"earn_rate": {
"spend_amount": 123
}
}