Adjust Member Pending Points

Adjusts the pending points with a given ID. You can add or subtract the number of points.

👍 Configuring pending points

Pending points are configured as part of an earning rule with POST Create earning rule or PUT Update earning rule.

POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance

cURL

Add pending points

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "points": 10
}'

200

Example

{
  "points": 5,
  "total": 16,
  "object": "balance",
  "related_object": {
    "type": "voucher",
    "id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc"
  },
  "operation_type": "MANUAL"
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

memberId · string · required

Unique loyalty card code assigned to a particular customer.

Example:

"MmFAzfDe"

pendingPointsId · string · required

Unique pending point identifier, assigned by Voucherify.

Body

application/json

Define the number of pending points to be added or subtracted.

Request body schema for POST v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance.

points · integer

Add or subtract pending points with a given ID. A negative value subtracts the points.

Response

200

application/json

Returns the details about the balance adjustment of the pending points with a given ID for a loyalty card.

Response body schema for POST /loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance.

points · integer · required

The number of pending points added to or subtracted from the loyalty card.

total · integer · required

Total number of pending points currently on a loyalty card.

object · enum<string> · default: balance · required

The type of the object represented by JSON. Default is balance.

Available options: balance

related_object · object · required

Defines the resource that is being modified.

Show child attributes

operation_type · enum<string> · default: MANUAL · required

The type of the operation being performed.

Available options: MANUAL