जर्नी से उपयोगकर्ताओं को हटाएं
POST https://journey.pushwoosh.com/api/journey/drop-users/external
सभी या विशिष्ट सक्रिय जर्नी से उपयोगकर्ताओं की एक सूची हटाता है।
अनुरोध हेडर
Anchor link to| नाम | आवश्यक | मान | विवरण |
|---|---|---|---|
| Content-Type | हाँ | application/json | |
| Authorization | हाँ | Api <server_api_token> | सर्वर 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 एक वर्णनात्मक message के साथ HTTP 400 लौटाता है।
{ "success": false, "message": "user_ids must be provided"}{ "success": false, "message": "journey_uuids must be provided if all_journeys is false"}