Version: 202601
Deduct points
POST/openapi/2026-01/loyalty/members/points/deduct
Subtract points from one or more members
Request
- application/json
- Body
- Example
Bodyrequired
operate_typestringrequired
Member locator type: member_id or email
operate_valuesstring[]required
Locator values to deduct. Up to 200 per request
pointsint64required
Points to deduct. Must be positive; server records a negative change
reasonstring
Business reason stored with the points change record
idempotency_keystring
Batch-level idempotency key
send_emailboolean
Whether to send a points-change notification email to the member
{
"operate_type": "string",
"operate_values": [
"string"
],
"points": 0,
"reason": "string",
"idempotency_key": "string",
"send_email": true
}
Responses
- 200
OK
- application/json
- Schema
- Example
Schema
- Array [
- ]
codestring
error code
messagestring
error message
data object
success_countint32
Number of successful items
failed_countint32
Number of failed items
results object[]
Points change results. change_value is negative
member_idstring
Resolved member ID
transaction_idstring
Points transaction ID
change_valueint64
Change amount. Positive for earn, negative for deduct
occurred_atstring
Effective time, ISO-8601
failed_valuesstring[]
Locator values that failed
{
"code": "string",
"message": "string",
"data": {
"success_count": 0,
"failed_count": 0,
"results": [
{
"member_id": "string",
"transaction_id": "string",
"change_value": 0,
"occurred_at": "string"
}
],
"failed_values": [
"string"
]
}
}