Remove users from journeys
Этот контент еще не доступен на вашем языке.
POST https://journey.pushwoosh.com/api/journey/drop-users/external
Removes a list of users from all or specific active journeys.
Request headers
Anchor link to| Name | Required | Value | Description |
|---|---|---|---|
| Content-Type | Yes | application/json | |
| Authorization | Yes | Api <server_api_token> | Server API token. |
Request body
Anchor link to| Field | Required | Type | Description |
|---|---|---|---|
user_ids | Yes | string[] | List of User IDs to remove from journeys. |
journey_uuids | Required if all_journeys is not provided or false | string[] | List of Journey IDs to remove users from. |
all_journeys | Required if journey_uuids is not provided | boolean | If true, users are removed from all journeys. If false, journey_uuids must be provided. |
Request examples
Anchor link toRemove users from all journeys
Anchor link to{ "user_ids": ["user1", "user2", "user3"], "all_journeys": true}Remove users from specific journeys
Anchor link to{ "user_ids": ["user1", "user2"], "journey_uuids": ["journey-uuid-1", "journey-uuid-2"]}Response example
Anchor link to{ "success": true}If the request is invalid, the API returns HTTP 400 with a descriptive message.
{ "success": false, "message": "user_ids must be provided"}{ "success": false, "message": "journey_uuids must be provided if all_journeys is false"}