پرش به مطلب اصلی

فیلدهای دفترچه

هر دفترچه می‌تواند فیلدهای سفارشی داشته باشد؛ مقدار آن‌ها برای هر مخاطب جدا ذخیره می‌شود و در کمپین‌ها به پارامتر الگو نگاشت می‌شود.

ساختار فیلد​

فیلدنوعالزامیتوضیح
keyرشتهخیرکلید انگلیسی، حداکثر ۳۲ نویسه. اگر ارسال نشود، خودکار field1, field2, … ساخته می‌شود
titleرشتهبلهعنوان، یکتا در هر دفترچه و حداکثر ۵۰ نویسه
typeعددبلهنوع فیلد؛ جدول زیر
typeنوعقالب مقدار
0متنحداکثر ۵۰۰ نویسه
1عددعددی
2تاریخشمسی یا میلادی
3بولیمقدار درست/نادرست
4تاریخ و ساعتشمسی یا میلادی، به وقت تهران

حداکثر ۳۰ فیلد در هر دفترچه مجاز است.

دریافت فیلدها​

GET /cms/api/Category/GetFields/{id}

curl -X GET "https://api.payavasms.com/cms/api/Category/GetFields/CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY"
[
{
"key": "city",
"title": "شهر",
"type": 0
},
{
"key": "birth",
"title": "تاریخ تولد",
"type": 2
}
]

ایجاد یا ویرایش فیلدها​

POST /cms/api/Category/UpsertFields/{id}

بدنه آرایه‌ای از فیلدهاست.

curl -X POST "https://api.payavasms.com/cms/api/Category/UpsertFields/CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '[
{
"key": "city",
"title": "شهر",
"type": 0
},
{
"key": "birth",
"title": "تاریخ تولد",
"type": 2
}
]'
[
{
"key": "city",
"title": "شهر",
"type": 0
},
{
"key": "birth",
"title": "تاریخ تولد",
"type": 2
}
]

حذف فیلدها​

POST /cms/api/Category/DeleteFields/{id}

بدنه آرایه‌ای از keyها است. پاسخ فیلدهای باقی‌مانده است.

curl -X POST "https://api.payavasms.com/cms/api/Category/DeleteFields/CATEGORY_ID" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '[
"city"
]'
[
{
"key": "birth",
"title": "تاریخ تولد",
"type": 2
}
]