Journey에서 사용자 제거
POST https://journey.pushwoosh.com/api/journey/drop-users/external
모든 또는 특정 활성 Journey에서 사용자 목록을 제거합니다.
요청 헤더
Anchor link to| 이름 | 필수 | 값 | 설명 |
|---|---|---|---|
| Content-Type | 예 | application/json | |
| Authorization | 예 | Api <server_api_token> | 서버 API 토큰입니다. |
요청 본문
Anchor link to| 필드 | 필수 | 타입 | 설명 |
|---|---|---|---|
user_ids | 예 | string[] | Journey에서 제거할 User ID 목록입니다. |
journey_uuids | 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는 설명 message와 함께 HTTP 400을 반환합니다.
{ "success": false, "message": "user_ids must be provided"}{ "success": false, "message": "journey_uuids must be provided if all_journeys is false"}