Перейти к содержанию

Удаление пользователей из 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 не предоставлен или равен falsestring[]Список 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
}

Связанные статьи

Anchor link to