إزالة المستخدمين من رحلات العملاء
POST https://journey.pushwoosh.com/api/journey/drop-users/external
يزيل قائمة من المستخدمين من جميع رحلات العملاء النشطة أو من رحلات محددة.
ترويسات الطلب
Anchor link to| الاسم | مطلوب | القيمة | الوصف |
|---|---|---|---|
| Content-Type | نعم | application/json | |
| Authorization | نعم | Api <server_api_token> | رمز Server API. |
نص الطلب
Anchor link to| الحقل | مطلوب | النوع | الوصف |
|---|---|---|---|
user_ids | نعم | string[] | قائمة من معرفات المستخدم (User IDs) لإزالتها من رحلات العملاء. |
journey_uuids | مطلوب إذا لم يتم توفير all_journeys أو كانت قيمته false | string[] | قائمة من معرفات رحلات العملاء (Journey IDs) لإزالة المستخدمين منها. |
all_journeys | مطلوب إذا لم يتم توفير journey_uuids | boolean | إذا كانت القيمة true، يتم إزالة المستخدمين من جميع رحلات العملاء. إذا كانت false، يجب توفير journey_uuids. |
أمثلة على الطلبات
Anchor link toإزالة المستخدمين من جميع رحلات العملاء
Anchor link to{ "user_ids": ["user1", "user2", "user3"], "all_journeys": true}إزالة المستخدمين من رحلات عملاء محددة
Anchor link to{ "user_ids": ["user1", "user2"], "journey_uuids": ["journey-uuid-1", "journey-uuid-2"]}مثال على الاستجابة
Anchor link to{ "success": true}إذا كان الطلب غير صالح، فإن الـ API يعيد HTTP 400 مع رسالة وصفية message.
{ "success": false, "message": "user_ids must be provided"}{ "success": false, "message": "journey_uuids must be provided if all_journeys is false"}