Remover usuários de jornadas
POST https://journey.pushwoosh.com/api/journey/drop-users/external
Remove uma lista de usuários de todas ou de jornadas ativas específicas.
Cabeçalhos da solicitação
Anchor link to| Nome | Obrigatório | Valor | Descrição |
|---|---|---|---|
| Content-Type | Sim | application/json | |
| Authorization | Sim | Api <server_api_token> | Token da API do servidor. |
Corpo da solicitação
Anchor link to| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
user_ids | Sim | string[] | Lista de IDs de Usuário para remover das jornadas. |
journey_uuids | Obrigatório se all_journeys não for fornecido ou for false | string[] | Lista de IDs de Jornada das quais os usuários serão removidos. |
all_journeys | Obrigatório se journey_uuids não for fornecido | boolean | Se true, os usuários são removidos de todas as jornadas. Se false, journey_uuids deve ser fornecido. |
Exemplos de solicitação
Anchor link toRemover usuários de todas as jornadas
Anchor link to{ "user_ids": ["user1", "user2", "user3"], "all_journeys": true}Remover usuários de jornadas específicas
Anchor link to{ "user_ids": ["user1", "user2"], "journey_uuids": ["journey-uuid-1", "journey-uuid-2"]}Exemplo de resposta
Anchor link to{ "success": true}Se a solicitação for inválida, a API retorna HTTP 400 com uma message descritiva.
{ "success": false, "message": "user_ids must be provided"}{ "success": false, "message": "journey_uuids must be provided if all_journeys is false"}