Light Mode

Update Customer Loyalty Points

Developing

POST/customers/loyalty/points

Last modified: 3 hours ago

This endpoint enables you to add loyalty points to customers, helping to enhance engagement and reward customer loyalty.

:::info
This endpoint will work only if the store has Customer Loyalty application installed.
:::

`customers.read_write` - Customers Read & write

Request

object {0}

{
  "points": 900,
  "reset_point": false,
  "type": "plus",
  "reason": "Valid reason text",
  "channel_send": [
    "email",
    "sms"
  ],
  "customers": [
    748394059,
    873874834
  ]
}

Request samples

Responses

Created(201)

Validation(422)

Bad Request(400)

HTTP Code: 201

Content Type : JSONapplication/json

status

integer

required

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

required

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object

required

message

string

required

Message indicator of response status

{
  "status": 201,
  "success": true,
  "data": {
    "code": 201,
    "message": "تم تحديث نقاط الولاء للعملاء بنجاح"
  }
}

Last modified: 3 hours ago