Xtrempay Api Documentation

Create a promotion

Cloud Mock

https://mock.apidog.com/m1/918700-0-default

POST

/v1/promotions

Maintainer:Not configured

Creates a new promotion.
Accepts application/json (with imageUrl) or multipart/form-data (with imageFile or imageUrl).

Request

Body Params application/json

Example

{
    "title": "Weekend Sale",
    "description": "Save 25% on selected items.",
    "imageUrl": "https://cdn.example.com/banners/weekend.png",
    "ctaUrl": "https://example.com/sale",
    "placement": "homepage",
    "startDate": "2025-10-17T00:00:00",
    "endDate": "2025-10-20T23:59:59",
    "priority": 1,
    "isActive": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/918700-0-default/v1/promotions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "Weekend Sale",
    "description": "Save 25% on selected items.",
    "imageUrl": "https://cdn.example.com/banners/weekend.png",
    "ctaUrl": "https://example.com/sale",
    "placement": "homepage",
    "startDate": "2025-10-17T00:00:00",
    "endDate": "2025-10-20T23:59:59",
    "priority": 1,
    "isActive": true
}'

Responses

🟢201Created

application/json

Created

Headers

Body

Example

{
    "timestamp": "2025-10-17T10:00:00",
    "status": 201,
    "success": true,
    "message": "Promotion created successfully",
    "data": {
        "id": 42,
        "title": "Weekend Sale",
        "description": "Save 25% on selected items.",
        "imageUrl": "https://cdn.example.com/banners/weekend.png",
        "ctaUrl": "https://example.com/sale",
        "placement": "homepage",
        "startDate": "2025-10-17T00:00:00",
        "endDate": "2025-10-20T23:59:59",
        "priority": 1,
        "isActive": true
    }
}

🟠400Bad Request

🔴500Server Error

Modified at 2025-10-17 15:06:35

Syncing All Billers details

Backfill referral codes