PhantomBuster

Visão geral

PhantomBuster é uma plataforma de extração de dados e automação em nuvem que permite automatizar ações na web, como raspar dados de redes sociais, gerar leads qualificados e automatizar tarefas em plataformas como LinkedIn, Twitter e outras. Com a integração PhantomBuster no SquadOS, seus agentes podem iniciar e monitorar automações, gerenciar leads no armazenamento da organização, executar scripts customizados e exportar relatórios de uso — tudo via API sem intervenção manual.

• Site oficial: https://phantombuster.com/
• Documentação na Composio: docs.composio.dev/toolkits/phantombuster

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim	Chave de API da sua conta PhantomBuster, usada para autenticar todas as chamadas à API.

Como obter a credencial

1. Acesse phantombuster.com e faça login na sua conta.
2. Clique no avatar ou no nome do seu perfil no canto superior direito e selecione Settings (Configurações).
3. Na barra lateral das configurações, clique em API (ou API Keys).
4. Copie a chave de API exibida — esse é o valor a usar no campo api_key ao conectar no SquadOS.

Dica

Mantenha sua chave de API confidencial. Qualquer pessoa com acesso a ela pode controlar seus agentes e acessar os dados da sua organização no PhantomBuster.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por PhantomBuster.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Abortar agente (v1)

PHANTOMBUSTER_ABORT_AGENT_V1

Aborta todas as instâncias em execução de um agente usando a API legada v1. Use quando precisar parar imediatamente a execução de um agente. Suporta aborto suave para encerramento gradual.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	integer	Sim	ID do agente a abortar. Todas as instâncias em execução deste agente serão paradas.
softAbort	boolean	Não	Se verdadeiro, tenta um aborto suave do agente, permitindo que ele conclua a operação atual antes de parar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir agente

PHANTOMBUSTER_DELETE_AGENT

Exclui um agente pelo ID. Use quando precisar remover um agente do PhantomBuster. Certifique-se de que o agente não está em execução antes da exclusão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do agente a excluir.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir objetos de lead

PHANTOMBUSTER_DELETE_LEAD_OBJECTS

Exclui um ou mais objetos de lead do armazenamento da organização. Use quando precisar remover dados de lead. Forneça leadObjectId ou ambos os parâmetros slug e type.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
slug	string	Não	Slug do objeto a excluir. Deve ser usado em conjunto com o parâmetro type.
type	string	Não	Tipo do objeto a excluir. Deve ser usado em conjunto com o parâmetro slug.
leadObjectId	string	Não	ID do objeto de lead a excluir. Forneça leadObjectId ou ambos slug e type.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir múltiplos leads

PHANTOMBUSTER_DELETE_LEADS_MANY

Exclui múltiplos leads do armazenamento da organização em lote. Use quando precisar remover leads em massa pelos seus IDs.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ids	array	Sim	Lista de IDs de leads a excluir. Cada ID deve ser uma string de identificador válido.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir lista

PHANTOMBUSTER_DELETE_LIST

Exclui uma lista de armazenamento pelo ID (Beta). Use quando precisar remover uma lista do armazenamento da organização.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID da lista a excluir.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir script

PHANTOMBUSTER_DELETE_SCRIPT

Exclui um script pelo ID. Use quando precisar remover um script específico do PhantomBuster. Opcionalmente especifique uma branch e ambiente para excluir uma versão específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do script a excluir.
branch	string	Não	Branch do script a excluir. Deve ter 1 a 50 caracteres, alfanuméricos, sublinhados ou hifens.
environment	string (“staging” | “release”)	Não	Enum do ambiente da branch do script.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter agente

PHANTOMBUSTER_GET_AGENT

Obtém um agente pelo seu ID. Use quando precisar recuperar informações detalhadas sobre um agente específico do PhantomBuster, incluindo configuração, agenda e configurações de execução.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do agente a buscar.
withCode	string	Não	Defina como “true” para incluir o código do script do agente na resposta.
withSlaves	string	Não	Defina como “true” para incluir os agentes subordinados na resposta.
withManifest	string	Não	Defina como “true” para retornar o manifesto do agente na resposta.
withSubSlaves	string	Não	Defina como “true” para incluir sub-agentes subordinados (requer withSlaves=true).
withAgentObject	string	Não	Defina como “true” para incluir o agent_object na resposta.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter containers do agente (v1)

PHANTOMBUSTER_GET_AGENT_CONTAINERS

Obtém a lista de containers encerrados de um agente, ordenados por data. Use quando precisar recuperar os últimos logs de saída disponíveis de um agente. Este é um endpoint legado da API v1.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do agente do qual recuperar os containers.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter saída do agente (v1)

PHANTOMBUSTER_GET_AGENT_OUTPUT

Obtém dados incrementais de um agente, incluindo saída do console, status, progresso e mensagens. Este é um endpoint legado da API v1 projetado para recuperação incremental de dados. Use outputPos para rastrear a posição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do agente do qual recuperar saída, status e mensagens.
mode	string (“track” | “most-recent”)	Não	Modo para selecionar qual instância do agente rastrear.
containerId	integer	Não	ID da instância específica da qual obter saída do console. Obrigatório quando o modo é ‘track’.
fromOutputPos	integer	Não	Retorna a saída do console do agente a partir desta posição. Use para recuperação incremental.
withoutResultObject	boolean	Não	Se verdadeiro, omite o objeto de resultado do agente para reduzir o tamanho do payload.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todos os agentes

PHANTOMBUSTER_GET_AGENTS_FETCH_ALL

Busca todos os agentes associados ao usuário ou organização atual. Use após validar sua chave de API do PhantomBuster para listar os agentes disponíveis.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar agentes excluídos

PHANTOMBUSTER_GET_AGENTS_FETCH_DELETED

Obtém os agentes excluídos do usuário ou organização atual. Use quando precisar auditar agentes removidos recentemente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter diff entre branches

PHANTOMBUSTER_GET_BRANCHES_DIFF

Obtém a diferença de tamanho entre a branch de staging e a de release de todos os scripts. Use para avaliar alterações entre branches antes da implantação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da branch do script para obter o diff.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação. Não necessário ao usar chave pessoal.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todas as branches

PHANTOMBUSTER_GET_BRANCHES_FETCH_ALL

Busca todas as branches associadas à organização atual. Use quando precisar enumerar todas as branches dos seus scripts.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todos os containers

PHANTOMBUSTER_GET_CONTAINERS_FETCH_ALL

Obtém todos os containers associados a um agente especificado. Use quando precisar recuperar cada container de um determinado agente para monitoramento ou relatórios.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
agentId	string	Sim	ID do agente cujos containers serão buscados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter leads por lista

PHANTOMBUSTER_GET_LEADS_BY_LIST

Busca leads pelo ID da lista. Use quando precisar recuperar leads de uma lista específica com paginação e filtragem opcionais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
listId	string	Sim	ID da lista de leads para buscar os leads.
withCompanies	boolean	Não	Opção para recuperar a empresa associada ao lead.
paginationOptions	object	Não	Opções para paginar pelos leads.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).
withLeadObjectsOfTypes	array	Não	Array de tipos de objetos de lead (máximo 3 itens).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter localização por IP

PHANTOMBUSTER_GET_LOCATION_IP

Recupera o país de um endereço IP fornecido ou do ambiente atual. Use quando precisar geolocalizar um endpoint IP. Exemplo: get_location_ip(ip="8.8.8.8").

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	string	Não	Endereço IPv4 ou IPv6 para recuperar o país. Omita para usar o IP público do ambiente atual.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Exportar uso de agentes em CSV

PHANTOMBUSTER_GET_ORGS_EXPORT_AGENT_USAGE

Exporta o CSV de uso de agentes da organização atual. Use quando precisar de um relatório para download com estatísticas de execução de todos os agentes em formato CSV.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
days	integer	Sim	Número de dias de dados a exportar (1 a 180).
agentId	string	Não	Se definido, exporta dados apenas para este ID de agente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Exportar uso de containers em CSV

PHANTOMBUSTER_GET_ORGS_EXPORT_CONTAINER_USAGE

Exporta o CSV de uso de containers da organização atual. Use quando precisar de um relatório CSV para download com o histórico de execução de containers em até 6 meses; a URL expira em 30 dias.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
days	integer	Sim	Número de dias de dados a exportar (1 a 180).
agentId	string	Não	Se definido, exporta dados apenas para este ID de agente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter organização

PHANTOMBUSTER_GET_ORGS_FETCH

Busca os detalhes da organização atual. Use quando precisar recuperar a organização associada à chave de API fornecida.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter grupos de agentes

PHANTOMBUSTER_GET_ORGS_FETCH_AGENT_GROUPS

Obtém os grupos de agentes e a ordem para a organização atual. Use quando precisar revisar como os agentes estão agrupados e ordenados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (omita ao usar sua própria chave de API).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter recursos da organização

PHANTOMBUSTER_GET_ORGS_FETCH_RESOURCES

Obtém os recursos e o uso da organização atual. Use quando precisar monitorar cotas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter containers em execução da organização

PHANTOMBUSTER_GET_ORGS_FETCH_RUNNING_CONTAINERS

Obtém os containers em execução da organização atual. Use após listar agentes para identificar containers ativos em toda a organização.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todas as listas de armazenamento da organização

PHANTOMBUSTER_GET_ORG_STORAGE_LISTS_FETCH_ALL

Busca todas as listas de armazenamento da organização autenticada. Use quando precisar enumerar cada lista de armazenamento disponível (Beta).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter script

PHANTOMBUSTER_GET_SCRIPT

Busca um script pelo seu ID único. Use quando precisar recuperar metadados detalhados de um script específico, incluindo suas branches, visibilidade e, opcionalmente, o código-fonte.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do script a buscar.
branch	string	Não	Se definido, a branch especificada será usada para recuperar o script.
withCode	string (“staging” | “release”)	Não	Enum de ambiente para o parâmetro withCode.
environment	string (“staging” | “release”)	Não	Enum de ambiente para branches de script.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação. Não necessário ao usar chave de terceiros.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter script por nome

PHANTOMBUSTER_GET_SCRIPT_BY_NAME

Recupera um script pelo nome no PhantomBuster (API legada v1). Use quando precisar buscar metadados ou conteúdo de script pelo nome. Suporta formatos de resposta JSON (estruturado) e raw (texto puro).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
mode	string (“json”)	Não	Formato de resposta: ‘json’ retorna metadados estruturados.
name	string	Sim	Nome do script a recuperar, com sua extensão (.js ou .coffee).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter código do script

PHANTOMBUSTER_GET_SCRIPTS_CODE

Obtém o código de um script. Use quando precisar recuperar o conteúdo do código-fonte de um script específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
org	string	Não	Se definido, a organização especificada será usada para buscar o código.
branch	string	Não	Se definido, a branch especificada será usada para buscar o código.
script	string	Sim	Nome do script para buscar o código.
environment	string (“staging” | “release”)	Não	Enum de ambiente para busca do código do script.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todos os scripts

PHANTOMBUSTER_GET_SCRIPTS_FETCH_ALL

Busca todos os scripts do usuário atual. Use após autenticar sua chave de API do PhantomBuster para listar scripts sem seus corpos de código.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter informações do usuário

PHANTOMBUSTER_GET_USER

Obtém informações sobre sua conta PhantomBuster e seus agentes usando a API legada v1. Use quando precisar verificar cotas da conta, recursos restantes ou listar agentes associados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Cancelar todos os agendamentos de agentes

PHANTOMBUSTER_POST_AGENTS_UNSCHEDULE_ALL

Cancela todos os lançamentos agendados para agentes. Use quando precisar desativar toda execução automatizada de agentes em toda a organização após verificar sua chave de API.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Solicitar completação de IA

PHANTOMBUSTER_POST_AI_COMPLETIONS

Solicita uma completação de texto do módulo de IA. Use quando precisar gerar texto com base em um prompt.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
n	integer	Não	Número de opções de completação a gerar.
stop	array	Não	Sequências onde a API para de gerar tokens adicionais.
topP	number	Não	Probabilidade de amostragem por núcleo entre 0 e 1.
model	string	Não	Identificador do modelo de IA a usar para a completação.
prompt	string	Sim	Texto de entrada para gerar uma completação.
maxTokens	integer	Não	Número máximo de tokens a gerar na completação.
temperature	number	Não	Temperatura de amostragem entre 0 e 1.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar branch

PHANTOMBUSTER_POST_BRANCHES_CREATE

Cria uma nova branch. Use quando precisar isolar atualizações criando uma branch separada. Use após autenticar com sua chave de API do PhantomBuster e, opcionalmente, especificar uma organização.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da branch a criar.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir branch

PHANTOMBUSTER_POST_BRANCHES_DELETE

Exclui uma branch pelo ID. Use quando precisar remover branches de script obsoletas ou incorretas; certifique-se de que a branch existe antes de chamar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador único da branch a excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Resolver hCaptcha

PHANTOMBUSTER_POST_HCAPTCHA

Resolve um desafio hCaptcha. Use quando precisar de um token hCaptcha válido para envios de formulários ou fluxos de automação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
proxy	string	Não	URL de proxy (ex.: http://user:pass@host:port) para rotear as requisições.
pageUrl	string	Sim	URL completa da página onde o hCaptcha aparece.
siteKey	string	Sim	Chave pública do widget hCaptcha.
userAgent	string	Não	User-Agent customizado para simular na requisição de resolução.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Gerar token de identidade

PHANTOMBUSTER_POST_IDENTITIES_GENERATE_TOKEN

Gera um token de identidade para o PhantomBuster. Use quando precisar criar um novo token de identidade para autenticação ou gerenciamento de sessão.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar múltiplos leads

PHANTOMBUSTER_POST_ORG_STORAGE_LEADS_SAVE_MANY

Salva múltiplos leads (1 a 20) no armazenamento da organização em uma única operação em lote (Beta). Use quando precisar criar ou atualizar leads com dados de perfil do LinkedIn e campos de enriquecimento opcionais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
leads	array	Sim	Array de leads a salvar. Deve conter entre 1 e 20 leads. Cada lead requer um linkedinProfileUrl.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Resolver reCAPTCHA

PHANTOMBUSTER_POST_RECAPTCHA

Resolve um desafio reCAPTCHA (v2 ou v3). Use quando precisar de um token de resposta reCAPTCHA válido para envios de formulários ou automação. Observação: a API retorna status 200 mesmo em erros; verifique o campo error na resposta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
key	string	Sim	Chave do site do widget reCAPTCHA (encontrada no HTML da página ou nas requisições de rede).
url	string	Sim	URL completa da página onde o widget reCAPTCHA aparece.
type	string (“v2” | “v3”)	Sim	Versão do reCAPTCHA a resolver: ‘v2’ para checkbox ou reCAPTCHA invisível, ‘v3’ para reCAPTCHA baseado em pontuação.
minScore	number	Não	Pontuação mínima exigida para reCAPTCHA v3 (entre 0 e 1). Aplicável apenas para type='v3'.
pageAction	string	Não	Nome da ação para reCAPTCHA v3 (corresponde ao parâmetro de ação em grecaptcha.execute). Aplicável apenas para type='v3'.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar visibilidade do script

PHANTOMBUSTER_POST_SCRIPTS_VISIBILITY

Atualiza a visibilidade de um script. Use quando precisar alterar se um script é privado, público ou de código aberto.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do script para alterar a visibilidade.
branch	string	Sim	Nome da branch para alterar a visibilidade.
visibility	string (“private” | “semi public” | “public” | “semi open source” | “open source”)	Sim	Nova visibilidade da branch.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Publicar branch

PHANTOMBUSTER_RELEASE_BRANCH

Publica uma branch de script. Use quando precisar implantar uma branch em produção ou publicar alterações em scripts especificados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da branch a publicar.
scriptIds	array	Sim	Lista de IDs de scripts a publicar.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar agente

PHANTOMBUSTER_SAVE_AGENT

Cria um novo agente ou atualiza um existente. Use quando precisar configurar o agendamento de lançamento, as configurações ou o comportamento de um agente. Se um ID de agente for fornecido, o agente existente será atualizado; caso contrário, um novo agente é criado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Não	Se fornecido, atualiza o agente existente com este ID. Se omitido, cria um novo agente.
org	string	Não	Organização à qual vincular o agente.
name	string	Não	Nome do agente (máx. 100 caracteres).
branch	string	Não	Branch a atribuir ao agente (alfanumérico, hífen, máx. 50 caracteres).
script	string	Não	Nome do arquivo de script a atribuir ao agente (ex.: ‘myscript.js’).
argument	string	Não	Argumento padrão usado para lançar o agente (string ou objeto).
expireAt	integer	Não	Timestamp Unix (epoch em ms) em que o agente será excluído.
fileMgmt	string (“folders” | “mix” | “delete”)	Não	Tipo de gerenciamento de arquivos do agente.
proxyType	string (“none” | “http” | “pool” | “squid lease”)	Não	Configuração do tipo de proxy.
launchType	string (“manually” | “repeatedly” | “once” | “after agent”)	Não	Tipo de lançamento do agente.
agentObject	string	Não	Define o objeto do agente como string JSON.
environment	string (“staging” | “release”)	Não	Ambiente da branch do script.
launchOnceAt	integer	Não	Deve ser definido quando launchType é ‘once’. Timestamp Unix (epoch em ms) para lançamento único.
proxyAddress	string	Não	Endereço de proxy HTTP (para proxyType='http') ou nome do pool de proxies (para proxyType='pool').
notifications	object	Não	Configurações de notificação do agente.
proxyPassword	string	Não	Senha para autenticação de proxy (usada com proxyType='http').
proxyUsername	string	Não	Nome de usuário para autenticação de proxy (usada com proxyType='http').
idempotencyKey	string	Não	Chave opcional para operações idempotentes — apenas para criação de agente.
maxParallelism	integer	Não	Número máximo de execuções simultâneas do agente.
maxRetryNumber	integer	Não	Número máximo de tentativas antes de o agente abortar.
executionTimeLimit	number	Não	Limite de tempo de execução em segundos. O agente será parado se esse limite for excedido.
fileMgmtMaxFolders	integer	Não	Número máximo de pastas para gerenciamento de arquivos.
launchAfterAgentId	string	Não	Deve ser definido quando launchType é ‘after agent’. ID do agente que aciona este agente.
repeatedLaunchTimes	object	Não	Configuração de agendamento para lançamentos repetidos.
repeatedLaunchPreset	string	Não	Presets de agendamento de lançamento (ex.: “Once per day”, “Once per hour”).
squidLeaseIdentifier	object	Não	Configuração de lease do Squid.
masterAgentLaunchAfter	number	Não	Atraso em segundos antes de lançar após um agente subordinado terminar.
masterAgentLaunchOnExitCodes	string	Não	Lança se o código de saída do agente subordinado corresponder aos valores do array, ou defina como ‘all’ para lançar em qualquer código.
applyScriptManifestDefaultSettings	boolean	Não	Se verdadeiro, aplica as configurações padrão do manifesto ao agente.
wasSetupValidWhenSubmittedByTheFrontend	boolean	Não	Se verdadeiro, a configuração do agente é considerada completa.
shouldPropagateUpdatedSettingsToWorkersRegardlessOfSessionType	boolean	Não	Se verdadeiro, propaga as configurações atualizadas para os workers independentemente do tipo de sessão.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar grupos de agentes

PHANTOMBUSTER_SAVE_AGENT_GROUPS

Atualiza os grupos de agentes e a ordem para a organização do usuário atual. Use quando precisar reorganizar agentes em grupos ou alterar a ordem de exibição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
agentGroups	array	Sim	Novos grupos de agentes. Pode ser uma lista de IDs de agentes (strings) ou objetos AgentGroup com id, name e agents. A ordem dos grupos e agentes será preservada.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar objeto de empresa

PHANTOMBUSTER_SAVE_COMPANY_OBJECT

Salva um objeto de empresa no armazenamento da organização. Use quando precisar criar ou atualizar um objeto de empresa com dados de empresa do LinkedIn e propriedades customizadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Não	ID interno do objeto de empresa. Se fornecido, atualiza o objeto existente.
slug	string	Sim	Slug do objeto de empresa.
type	string	Sim	Tipo do objeto de empresa.
orgId	string	Não	ID da organização associada ao objeto de empresa.
properties	object	Sim	Propriedades do objeto. Pode conter quaisquer dados adicionais da empresa.
linkedinCompanyId	string	Sim	ID externo da empresa extraído do LinkedIn.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar múltiplos objetos de empresa

PHANTOMBUSTER_SAVE_COMPANY_OBJECTS_MANY

Salva múltiplos objetos de empresa no armazenamento da organização. Use quando precisar inserir ou atualizar dados de empresa em lote, com mínimo de 1 e máximo de 20 objetos por requisição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
companies	array	Sim	Lista de objetos de empresa a salvar. Mínimo 1, máximo 20 objetos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar evento de identidade

PHANTOMBUSTER_SAVE_IDENTITY_EVENT

Salva um evento de identidade no PhantomBuster. Use quando precisar registrar interações ou atividades de usuário associadas a perfis específicos de redes sociais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
timestamp	integer	Não	Timestamp opcional do evento de identidade em milissegundos desde a época. Deve estar entre 1000000000000 e 9999999999999.
event_data	object	Sim	Dados do evento de identidade contendo informações adicionais sobre o evento.
event_type	string	Sim	Tipo do evento de identidade (ex.: profile_view, connection_request).
profile_id	string	Sim	ID do perfil do evento de identidade.
identity_type	string	Sim	Tipo de identidade do evento (ex.: linkedin, twitter, facebook).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar lead

PHANTOMBUSTER_SAVE_LEAD

Salva ou atualiza um lead no armazenamento da organização do PhantomBuster. Use quando precisar armazenar dados de perfil do LinkedIn ou outras informações de lead.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
linkedinProfileUrl	string	Sim	URL do perfil do LinkedIn do lead (obrigatório). É o identificador único do lead.
error	string	Não	Mensagem de erro caso tenha havido um problema ao processar o lead.
civility	string	Não	Tratamento ou título do lead (ex.: Sr., Sra., Dr.).
lastName	string	Não	Sobrenome do lead.
location	string	Não	Localização geográfica do lead.
metadata	object	Não	Metadados adicionais do lead.
websites	array	Não	Lista de sites associados ao lead.
firstName	string	Não	Nome do lead.
companyName	string	Não	Nome da empresa atual do lead.
phoneNumbers	array	Não	Lista de números de telefone do lead.
companyWebsite	string	Não	Site da empresa atual do lead.
personalEmails	array	Não	Lista de e-mails pessoais do lead.
audienceOfLeads	array	Não	Segmentos de público a que este lead pertence.
companyIndustry	string	Não	Setor da empresa atual do lead.
linkedinHeadline	string	Não	Headline do LinkedIn do lead.
linkedinJobTitle	string	Não	Cargo atual do lead no LinkedIn.
linkedinCompanyId	string	Não	ID da empresa no LinkedIn do lead.
linkedinProfileId	string	Não	ID do perfil do LinkedIn do lead.
twitterProfileUrl	string	Não	URL do perfil do Twitter do lead.
linkedinCompanyUrl	string	Não	URL da empresa no LinkedIn.
linkedinProfileUrn	string	Não	URN do perfil do LinkedIn do lead.
linkedinSchoolName	string	Não	Nome da escola do lead no LinkedIn.
professionalEmails	array	Não	Lista de e-mails profissionais do lead.
linkedinCompanySlug	string	Não	Slug da empresa no LinkedIn.
linkedinDescription	string	Não	Descrição ou resumo do lead no LinkedIn.
linkedinJobLocation	string	Não	Localização do cargo atual do lead no LinkedIn.
linkedinOpenProfile	boolean	Não	Se o lead tem um perfil aberto no LinkedIn.
linkedinSkillsLabel	string	Não	Rótulo de habilidades do perfil do LinkedIn do lead.
previousCompanyName	string	Não	Nome da empresa anterior do lead.
linkedinJobDateRange	string	Não	Período do cargo atual do lead no LinkedIn.
linkedinSchoolDegree	string	Não	Grau obtido na escola do lead no LinkedIn.
aiGeneratedProperties	object	Não	Propriedades geradas por IA para o lead.
customResultsFileName	string	Não	Nome de arquivo de resultados customizado para o lead.
linkedinIsHiringBadge	boolean	Não	Se o lead tem um badge de contratação no LinkedIn.
linkedinFollowersCount	number	Não	Número de seguidores do lead no LinkedIn.
linkedinJobDescription	string	Não	Descrição do cargo atual do lead no LinkedIn.
linkedinProfileImageUrl	string	Não	URL da imagem de perfil do LinkedIn do lead.
linkedinProfileImageUrn	string	Não	URN da imagem de perfil do LinkedIn do lead.
linkedinSchoolDateRange	string	Não	Período de frequência na escola do lead no LinkedIn.
linkedinPreviousJobTitle	string	Não	Cargo anterior do lead no LinkedIn.
linkedinSchoolCompanyUrl	string	Não	URL da escola do lead no LinkedIn.
salesNavigatorProfileUrl	string	Não	URL do perfil do Sales Navigator do lead.
linkedinIsOpenToWorkBadge	boolean	Não	Se o lead tem um badge de “aberto para trabalho” no LinkedIn.
linkedinSchoolDescription	string	Não	Descrição da escola do lead no LinkedIn.
linkedinPreviousCompanyUrl	string	Não	URL da empresa anterior do lead no LinkedIn.
linkedinPreviousSchoolName	string	Não	Nome da escola anterior do lead no LinkedIn.
linkedinPreviousJobLocation	string	Não	Localização do cargo anterior do lead no LinkedIn.
crmAccountRelativeProperties	array	Não	Propriedades relativas da conta CRM do lead.
linkedinPreviousJobDateRange	string	Não	Período do cargo anterior do lead no LinkedIn.
linkedinPreviousSchoolDegree	string	Não	Grau obtido na escola anterior do lead no LinkedIn.
linkedinPreviousJobDescription	string	Não	Descrição do cargo anterior do lead no LinkedIn.
linkedinPreviousSchoolDateRange	string	Não	Período de frequência na escola anterior do lead no LinkedIn.
linkedinPreviousSchoolCompanyUrl	string	Não	URL da escola anterior do lead no LinkedIn.
linkedinAccountRelativeProperties	array	Não	Propriedades relativas da conta LinkedIn do lead.
linkedinPreviousSchoolDescription	string	Não	Descrição da escola anterior do lead no LinkedIn.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar objeto de lead

PHANTOMBUSTER_SAVE_LEAD_OBJECT

Salva um objeto de lead no armazenamento da organização. Use quando precisar armazenar ou atualizar informações de lead com propriedades customizadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
slug	string	Sim	Slug do objeto a salvar. Deve ter no máximo 470 caracteres.
type	string	Sim	Tipo do objeto a salvar.
leadId	string	Não	ID do lead a associar a este objeto.
agentId	string	Sim	ID do agente associado a este objeto de lead.
leadUrn	string	Não	URN do lead a associar a este objeto.
leadSlug	string	Não	Slug do lead a associar a este objeto.
properties	object	Sim	Propriedades do objeto. Pode conter quaisquer pares chave-valor.
leadObjectId	string	Não	ID do objeto de lead a atualizar. Se fornecido, atualiza o objeto existente em vez de criar um novo.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar múltiplos objetos de lead

PHANTOMBUSTER_SAVE_LEADS_OBJECTS_MANY

Salva múltiplos objetos de lead no armazenamento da organização do PhantomBuster. Use quando precisar criar ou atualizar múltiplos objetos de lead em uma única chamada de API.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
leadsObjects	array	Sim	Array de objetos de lead a salvar. Cada objeto deve incluir type, slug, properties e agentId.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar lista

PHANTOMBUSTER_SAVE_LIST

Salva (cria ou atualiza) uma lista com critérios de filtro. Use quando precisar criar uma nova lista ou atualizar uma existente fornecendo uma configuração de filtro. Este é um recurso Beta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Não	String para atualizar listas existentes (omita ao criar novas).
name	string	Sim	Título da lista.
tags	array	Não	Array de strings para categorização. Valores permitidos: ‘hidden’, ‘workflow’, ‘pbai’, ‘opinion-leaders’.
filter	object	Sim	Objeto que configura quais leads são incluídos na lista. Suporta busca global com a chave '__global_search__', filtros simples por campo, operadores AND/OR e filtros aninhados complexos.
description	string	Não	Descrição da finalidade da lista.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Salvar script

PHANTOMBUSTER_SAVE_SCRIPT

Cria um novo script ou atualiza um existente. Forneça um id para atualizar; caso contrário, cria um novo script. Use quando precisar salvar código JavaScript de automação no PhantomBuster.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Não	Se fornecido, o script com este ID será atualizado. Caso contrário, um novo script é criado.
code	string	Não	Código-fonte JavaScript do script (máx. 600.000 caracteres).
name	string	Sim	Nome do arquivo de script. Deve terminar em .js ou .coffee. Prefixe com ‘lib-’ para definir como módulo.
branch	string	Não	Nome da branch a associar ao script (alfanumérico, hifens, 1 a 50 caracteres).
manifest	object	Não	Manifesto JSON do script necessário para criar/atualizar um script.
markdown	string	Não	Descrição em Markdown do script (máx. 200.000 caracteres).
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar objetos de empresa

PHANTOMBUSTER_SEARCH_COMPANY_OBJECTS

Busca objetos de empresa no armazenamento organizacional do PhantomBuster. Use quando precisar encontrar empresas por critérios específicos ou realizar uma busca global.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
or	array	Não	Array de condições de filtro unidas por lógica OR. Cada condição é um objeto com nomes de campo como chaves e valores string.
and	array	Não	Array de condições de filtro unidas por lógica AND. Cada condição é um objeto com nomes de campo como chaves e valores string.
filter	object	Não	Objeto de filtro aninhado para lógica de filtragem mais complexa com nomes de campo como chaves.
__global_search__	string	Não	String de busca global para pesquisar em todos os campos dos objetos de empresa.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar objetos de lead

PHANTOMBUSTER_SEARCH_LEAD_OBJECTS

Busca objetos de lead no armazenamento da organização do PhantomBuster. Use quando precisar encontrar leads com base em critérios de busca ou condições de filtro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
filter	object	Sim	Critérios de filtro para buscar leads. Use '__global_search__' para buscas textuais simples em todos os campos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Parar agente

PHANTOMBUSTER_STOP_AGENT

Para um agente em execução. Use quando precisar interromper a execução de um agente, com opção de cascata para agentes subordinados ou alternância para modo de lançamento manual.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do agente a parar.
softAbort	boolean	Não	Se verdadeiro, tenta abortar o agente de forma suave.
dontLaunchSoon	boolean	Não	Se verdadeiro, desativa o próximo ‘lançamento em breve’ agendado do agente.
cascadeToAllSlaves	boolean	Não	Se verdadeiro, agentes subordinados serão recursivamente parados (inclusive subordinados aninhados).
switchToManualLaunch	boolean	Não	Se verdadeiro, o agente alternará para modo de lançamento manual.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar script (API v1)

PHANTOMBUSTER_UPDATE_SCRIPT

Atualiza um script existente ou cria um novo caso não exista (API legada v1). Use quando precisar salvar código de script no PhantomBuster. Se insertOnly for verdadeiro, a operação falhará se um script com o mesmo nome já existir.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do script a atualizar ou criar, com sua extensão (.js ou .coffee).
text	string	Sim	Conteúdo completo do script.
insertOnly	boolean	Não	Se verdadeiro, garante que um script existente não seja atualizado. Um erro será retornado se um script com o mesmo nome já existir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar lista de acesso do script

PHANTOMBUSTER_UPDATE_SCRIPTS_ACCESS_LIST

Atualiza a lista de acesso de um script. Use quando precisar adicionar ou remover usuários/organizações da lista de acesso de um script em uma branch específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
add	string	Não	Organização ou usuário a adicionar na lista de acesso.
name	string	Sim	Nome do script para atualizar a lista de acesso.
branch	string	Sim	Nome da branch para atualizar a lista de acesso.
remove	string	Não	Organização ou usuário a remover da lista de acesso.
X-Phantombuster-Org	string	Não	ID da organização que está realizando a operação (desnecessário ao usar chave de terceiros).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.