从 Journey 中移除用户
POST https://journey.pushwoosh.com/api/journey/drop-users/external
从所有或指定的活跃 Journey 中移除用户列表。
| 名称 | 必需 | 值 | 描述 |
|---|---|---|---|
| Content-Type | 是 | application/json | |
| Authorization | 是 | Api <server_api_token> | 服务器 API 令牌。 |
| 字段 | 必需 | 类型 | 描述 |
|---|---|---|---|
user_ids | 是 | string[] | 要从 Journey 中移除的 User ID 列表。 |
journey_uuids | 如果未提供 all_journeys 或 all_journeys 为 false,则为必需 | string[] | 要从中移除用户的 Journey ID 列表。 |
all_journeys | 如果未提供 journey_uuids,则为必需 | boolean | 如果为 true,则用户将从所有 Journey 中移除。如果为 false,则必须提供 journey_uuids。 |
请求示例
Anchor link to从所有 Journey 中移除用户
Anchor link to{ "user_ids": ["user1", "user2", "user3"], "all_journeys": true}从指定的 Journey 中移除用户
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"}