مستندات پوشفا

ساخت و تکمیل پروفایل RetenX

ساخت یا بروزرسانی Subscriber مستقل از Push با External ID، شماره موبایل، aliasها و ویژگی‌های پروفایل.

POST
https://pushfa.com/api/webservices/retention/profiles/upsert
📥 دانلود کالکشن Postman

کاربرد

این endpoint برای CRM، فرم سرنخ، ثبت‌نام و خرید سروری است. اگر alias داده‌شده از قبل وجود داشته باشد همان پروفایل بروزرسانی می‌شود؛ در غیر این صورت یک Subscriber ID جدید بدون FCM token ساخته می‌شود. وقتی SDK بعداً Push را ثبت کند، توکن به همین Subscriber ID متصل می‌شود.

پارامترها

فیلد توضیح الزام
api_public_key کلید عمومی سرویس پوشفا بله
api_private_key کلید خصوصی سرویس پوشفا بله
subscriber_id شناسه پروفایل موجود برای بروزرسانی مستقیم خیر
external_id شناسه اصلی کاربر در سیستم شما خیر؛ اگر aliases وجود دارد
aliases[mobile] شماره موبایل یا هر alias با label دلخواه حداقل external_id یا یک alias
properties[key] ویژگی‌های ماندگار پروفایل مانند نام، شهر یا پلن خیر

نمونه form-data

curl -X POST https://pushfa.com/api/webservices/retention/profiles/upsert \
  -F "api_public_key=YOUR_PUBLIC_KEY" \
  -F "api_private_key=YOUR_PRIVATE_KEY" \
  -F "external_id=customer-42" \
  -F "aliases[mobile]=09120000000" \
  -F "aliases[crm_id]=CRM-9182" \
  -F "properties[name]=سارا"

پاسخ

{
  "data": {
    "subscriber_id": "UUID",
    "external_id": "customer-42",
    "aliases": { "mobile": "09120000000" },
    "has_push": false
  }
}