Aplicar uma ação em massa no CRM

Aplica uma única ação às conversas selecionadas: move_stage (mover de etapa, value é a etapa), move_funnel (mover de funil), assign (atribuir, value é o usuário; segue a mesma regra de atribuir uma conversa pelo WebSocket: o usuário precisa ter acesso a conversas no workspace e estar ao seu alcance de departamentos), add_label e remove_label (value é a etiqueta), close (finalizar; envie outcomeCode quando o workspace exige desfecho; exige conversations:send e passa pela mesma regra e pelo mesmo serviço de status de finalizar uma conversa pelo WebSocket) ou mark_read (marca como lidas as mensagens do contato, como o mark_read do WebSocket, e tira a sua marca pessoal de não lida; exige conversations:read; não envia confirmação de leitura ao canal). Cada conversa roda a ação sozinha, como a ação de uma conversa: as que falham aparecem em failed com o motivo (por exemplo, desfecho obrigatório ou conversa fora do seu alcance) e as demais seguem. A seleção tem exatamente um modo: ids (targets escolhidos), all_matching (um filtro não vazio) ou everyone (todo o escopo do usuário, só com expectedCount). Para all_matching e everyone, fingerprint vem de POST /crm/bulk/count e é obrigatório; expectedCount é o matched dessa contagem, tomada antes das exclusões: excludeIds tira conversas da seleção sem mudar a contagem confirmada. Se a contagem mudou, responde 409 selection_changed com a nova contagem. targets junto com all_matching ou everyone é recusado (selection_ambiguous). Sem mode, targets valem como ids, um filtro não vazio como all_matching e um filtro vazio como everyone, com as mesmas exigências. Um departamento fora do escopo do usuário responde 403 selection_scope_denied; um filtro que não se aplica a conversas responde 400 invalid_filter. A contagem passa pelo limitador de agregados: ocupado, responde 503 com Retry-After. No máximo 2000 conversas por chamada (truncated indica que restam outras), em ordem estável por id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Ação, seleção e valor

string
excludeIds
array of strings
excludeIds
integer
filter
object
string
string
enum
Allowed:
string
targets
array of objects
targets
string
Headers
string

Workspace da requisição. Sem ele vale o workspace padrão da pessoa; um workspace do qual ela não participa responde 403 workspace_not_member.

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json