Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Update Cashback Rule

POST

https://api.zid.sa/v1/managers/loyalty-program/points-collection/update

Updates the configuration of a cashback rule within a store's loyalty program.

🔑Scopes

loyalty_program.read_write - Loyalty Program Read & Write

Request

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/managers/loyalty-program/points-collection/update' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--form 'ruleId=""' \
--form 'config[money]=""' \
--form 'config[points]=""'

Responses

🟢200OK

application/json

The cashback rule method status is updated successfully.

Body

Example

{
    "status": {},
    "data": {
        "status": true,
        "message": "Points collection updated successfully",
        "is_cashback_enabled": false,
        "points_collection_methods_list": [
            {
                "id": "b1e3ca5d-2a89-4993-89bf-0f31a4b70b00",
                "external_id": "pos",
                "store_id": "3dfc16e6-ad19-4126-9c2a-5e4a7fb73051",
                "points_rewarded": 1,
                "amount_to_spend": 100,
                "available_to": null,
                "is_active": false,
                "created_at": "2023-12-28T10:32:13.000000Z",
                "updated_at": "2023-08-28T10:32:13.000000Z",
                "deleted_at": null
            }
        ]
    },
    "message": {
        "type": "string",
        "code": "MSG_POPUP_OK",
        "name": "Points collection",
        "description": "Points collection updated successfully"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠422Unprocessable Entity

🔴500Internal Server error

Modified at 2026-03-02 13:03:40

Set Points Expiration Rules

Create Points Redemption Method