Skip to main content
POST
/
v1
/
loyalty
/
program_event_adjustments
Create a loyalty program event adjustment
curl --request POST \
  --url https://api.yorlet.com/v1/loyalty/program_event_adjustments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "loyalty_program_event": "<string>",
  "type": "cancel"
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "loyalty.program_event",
  "loyalty_program_event": "<string>",
  "type": "cancel",
  "account": "<string>",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
loyalty_program_event
string
required

The loyalty program event ID

​
type
enum<string>
required

The type of adjustment

Available options:
cancel

Response

200 - application/json

Create a loyalty program event adjustment

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
loyalty.program_event
​
loyalty_program_event
string
required

The loyalty program event ID

​
status
enum<string>
required

The status of the adjustment

Available options:
pending,
succeeded
​
type
enum<string>
required

The type of adjustment

Available options:
cancel
​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.