Удаление пользователей из Journey
POST https://journey.pushwoosh.com/api/journey/drop-users/external
Удаляет список пользователей из всех или определенных активных Journey.
Заголовки запроса
Anchor link to| Название | Обязательно | Значение | Описание |
|---|---|---|---|
| Content-Type | Да | application/json | |
| Authorization | Да | Api <server_api_token> | Server API token. |
Тело запроса
Anchor link to| Поле | Обязательно | Тип | Описание |
|---|---|---|---|
user_ids | Да | string[] | Список User ID для удаления из Journey. |
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 возвращает HTTP 400 с описательным message.
{ "success": false, "message": "user_ids must be provided"}{ "success": false, "message": "journey_uuids must be provided if all_journeys is false"}