Skip to main content

Create ZNS Template

This API allows you to create a Zalo Notification Service (ZNS) Template with full display content and dynamic parameters. When sending a request, you can define:

  • Basic information: name, description, title

  • Display content:

    • paragraphs: list of text paragraphs

    • tables: dynamic data tables with label and key

    • buttons: list of buttons with links or actions

    • Images & logo: logoLight, logoDark, images

    • Dynamic parameters (params): allow inserting actual values into the template (e.g., customer_fullname, order_code, order_status)

    • Additional information: note, status

Endpoint​

🔗Endpoint Staging
Endpoint
POST https://staging.manage-api.miniap.vn/api/external/zns-template/create
🔗Endpoint Production
Endpoint
POST https://manage-api.miniap.vn/api/external/zns-template/create

Request Body​

{
    "name": "Khảo sát 2/7/2025",
    "description": "Khảo sát 2/7/2025",
    "title": "Xin chào <customer_fullname>,",
    "paragraphs": [
        {
            "id": "10c8db12-7f66-4b53-a79c-22b5a01dac49",
            "value": "Cảm ơn bạn đã mua sản phẩm tại cửa hàng"
        }
    ],
    "tables": [
        {
            "label": "Mã đơn hàng",
            "key": "<order_code>"
        },
        {
            "label": "Trạng thái",
            "key": "<order_status>"
        }
    ],
    "buttons": [
        {
            "value": "https://manage.miniai.vn/marketing/uid-templates/new",
            "type": "1",
            "label": "Nhận"
        }
    ],
    "logoLight": "",
    "logoDark": "",
    "images": [],
    "params": [
        {
            "key": "customer_fullname",
            "label": "Customer fullname"
        },
        {
            "key": "order_code",
            "label": "Order code"
        },
        {
            "key": "order_status",
            "label": "Order status"
        }
    ],
    "note": "test",
    "status": "DRAFT"
}

Response​

{
    "template": {
        "name": "Khảo sát 2/7/2025",
        "description": "Khảo sát 2/7/2025",
        "title": "Xin chào <customer_fullname>,",
        "tables": [
            {
                "label": "Mã đơn hàng",
                "key": "<order_code>"
            },
            {
                "label": "Trạng thái",
                "key": "<order_status>"
            }
        ],
        "buttons": [
            {
                "value": "https://manage.miniai.vn/marketing/uid-templates/new",
                "label": "Nhận",
                "type": "1"
            }
        ],
        "params": [
            {
                "label": "Customer fullname",
                "key": "customer_fullname"
            },
            {
                "label": "Order code",
                "key": "order_code"
            },
            {
                "label": "Order status",
                "key": "order_status"
            }
        ],
        "paragraphs": [
            {
                "value": "Cảm ơn bạn đã mua sản phẩm tại cửa hàng",
                "key": "10c8db12-7f66-4b53-a79c-22b5a01dac49"
            }
        ],
        "logoDark": "",
        "logoLight": "",
        "images": [],
        "note": "test",
        "shopId": "64204a17a5a97a86f12e1f0a",
        "status": "DRAFT",
        "isSync": false,
        "_id": "68c8ee675f8f83fc813e7830",
        "createdAt": "2025-09-16T04:58:15.668Z",
        "updatedAt": "2025-09-16T04:58:15.668Z",
        "id": "68c8ee675f8f83fc813e7830"
    }
}