Update Promotion Parameters

Production

https://api.mircate.com/5p1hp1d2t

POST

/CALL/Promotion/updatePromotionParameters/{MIRCATE_PROJECT_ID}

Last modified:2025-12-12 08:25:03

This method is used to update the parameters of an existing promotion. It allows modifying the promotion’s conditions, limits, assigned products, segments, or other configuration settings.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Body Params application/json

Example

{
    "id": "xYGqjSjyBfYaPVoa",
    "parameters": {
        "amountOff": 1200,
        "buyCount": 1,
        "customerSegment": "FAMILY",
        "orderAmount": 1000,
        "amount": 1,
        "loyaltyCard": false,
        "exclBuyCategories": []
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.mircate.com/5p1hp1d2t/CALL/Promotion/updatePromotionParameters/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "xYGqjSjyBfYaPVoa",
    "parameters": {
        "amountOff": 1200,
        "buyCount": 1,
        "customerSegment": "FAMILY",
        "orderAmount": 1000,
        "amount": 1,
        "loyaltyCard": false,
        "exclBuyCategories": []
    }
}'

Responses

🟢200OK

application/json

Body

Example

{
    "message": "Promotion parameters updated successfully",
    "promotion": {
        "title": "Mircate-Promotion",
        "active": true,
        "description": "",
        "tag": "",
        "finishDate": "2025-12-26T21:00:00.000Z",
        "startDate": "2025-12-15T21:00:00.000Z",
        "userMessage": "",
        "segments": [],
        "params": {
            "orderAmount": 1000,
            "customerSegment": "FAMILY",
            "amountOff": 1200,
            "arrayParam": [
                "iphone14"
            ],
            "birthday": "2024-12-15T21:00:00.000Z",
            "buyCount": 1,
            "amount": 1,
            "loyaltyCard": false,
            "exclBuyCategories": []
        },
        "promotionTemplateId": "np3K",
        "orderLevel": 1,
        "priority": 0,
        "maxUseCount": 0,
        "maxUseAmount": 0,
        "maxUseCountPerCustomer": 0,
        "maxUseAmountPerCustomer": 0,
        "checkCategory": false,
        "isForceApply": true,
        "isExclusive": false,
        "locales": {
            "tr_TR": {
                "title": "Mircate-Promotion",
                "userMessage": ""
            }
        },
        "exclusions": [],
        "promotionType": "normal",
        "imageUrl": "https://api.b2btest.retter.io/331d4nbu6/CALL/Image/get?image=7WIDI4TYHR22EU3USLRSPH90.png",
        "id": "CT7EWNKI",
        "updatedAt": "2025-12-10T14:56:01.082Z",
        "createdAt": "2025-12-10T13:42:06.325Z"
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-12-12 08:25:03

Set Status For Promotion List

Get Active Promotions