Zoho

Visão geral

Zoho é uma suíte de aplicativos em nuvem que inclui CRM, marketing por e-mail, ferramentas de colaboração e muito mais, permitindo que empresas automatizem e escalem suas operações. Com a integração Zoho no SquadOS, seus agentes podem criar, atualizar e consultar registros de CRM, converter leads, fazer buscas avançadas e gerenciar relacionamentos entre módulos diretamente a partir de conversas e fluxos automatizados.

• Documentação na Composio: docs.composio.dev/toolkits/zoho

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

A autenticação é feita via página de autorização da Composio. Você precisa de uma conta Zoho ativa para concluir o fluxo OAuth.

Como obter a credencial

Para usar suas próprias credenciais de desenvolvedor (em vez do app gerenciado pela Composio):

1. Acesse o Zoho API Console e crie um aplicativo do tipo Server-based Application.
2. Preencha os dados do aplicativo:
   • Client Name: nome de sua escolha (ex.: Minha Integração Composio)
   • Homepage URL: https://backend.composio.dev
   • Authorized Redirect URIs: https://backend.composio.dev/api/v1/auth-apps/add
3. Salve — o Zoho gera seu Client ID e Client Secret.
4. No painel da Composio, vá em Create Auth Config → Zoho CRM, confirme o tipo OAuth2, adicione os escopos desejados e habilite Use your own developer credentials.
5. Cole o Client ID e o Client Secret obtidos no passo 3.

Dica

O Console do Zoho não permite adicionar escopos manualmente — use o campo Manage Scopes da Composio ao criar o Auth Config para definir as permissões necessárias.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Zoho.
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 autoriza o acesso à sua conta Zoho via OAuth.
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.)

Perguntas frequentes

Como configurar credenciais OAuth personalizadas para o Zoho CRM?

Siga os passos da seção “Como obter a credencial” acima. Para um guia passo a passo detalhado, consulte também How to create OAuth credentials for Zoho CRM.

Ações disponíveis

Converter lead do Zoho CRM

ZOHO_CONVERT_ZOHO_LEAD

Converte um lead em contato, conta e, opcionalmente, em um negócio no Zoho CRM.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
lead_id	string	Sim	O ID único do lead a ser convertido.
assign_to	string	Não	ID do usuário a ser definido como proprietário do novo contato/conta.
overwrite	boolean	Não	Se deve sobrescrever o nome da conta no contato quando já existe e os nomes de empresa diferem.
account_id	string	Não	ID de uma conta existente para associar ao lead convertido.
contact_id	string	Não	ID de um contato existente para associar ao lead convertido.
notify_lead_owner	boolean	Não	Notificar o proprietário do lead sobre a conversão por e-mail.
notify_new_entity_owner	boolean	Não	Notificar o novo proprietário do contato/conta por e-mail.

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 registro no Zoho CRM

ZOHO_CREATE_ZOHO_RECORD

Cria novos registros em um módulo específico do Zoho CRM. Operações em lote podem ter sucesso parcial — verifique o campo de status de cada item na resposta, pois alguns registros podem ser criados enquanto outros falham.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	array	Sim	Lista de dicionários representando os registros a criar. Cada dicionário contém os nomes de API dos campos como chaves e seus valores. Os campos obrigatórios dependem do módulo (ex.: Last_Name é obrigatório para Leads e Contacts e NÃO pode ser vazio). Para campos de lookup, use o formato simplificado: {"id": "<record_id>", "module": "<ModuleName>"} (ex.: {"id": "123456", "module": "Accounts"}) ou o formato completo de API para Parent_Id: {"id": "<record_id>", "module": {"api_name": "<ModuleName>"}}. IMPORTANTE: What_Id é para objetos de negócios (Accounts, Deals, Products, Quotes, Sales_Orders, Purchase_Orders, Invoices, Campaigns, Vendors, Cases, Leads). Who_Id é para módulos de pessoas (Contacts, Leads). Use Who_Id para Contacts. Para atribuir um proprietário, use o campo "Owner" com um ID de usuário Zoho válido em formato dict (ex.: {"id": "<user_id>"}); nomes de campos incorretos falham silenciosamente. Para Tasks, inclua apenas os campos mínimos obrigatórios — campos extras dependentes de layout podem causar erros INVALID_DATA.
lar_id	string	Não	ID do layout ou regra de atribuição de lead a ser usado, se necessário.
trigger	array	Não	Lista de gatilhos a acionar durante a criação do registro (ex.: ['workflow', 'blueprint']). Habilitar gatilhos pode causar efeitos colaterais (e-mails enviados, outros registros modificados) — inclua apenas quando esses efeitos forem explicitamente desejados, especialmente em operações em lote.
module_api_name	string	Sim	O nome de API do módulo no qual criar o registro. Módulos padrão usam PascalCase (ex.: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', 'Campaigns'). Módulos personalizados devem usar seu nome de API exato como configurado no Zoho CRM — não é o nome de exibição. Para encontrar o nome de API de um módulo personalizado: vá em Setup > Developer Hub > APIs and SDKs > API Names.

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 tag no Zoho CRM

ZOHO_CREATE_ZOHO_TAG

Cria uma nova tag no Zoho CRM para um módulo específico. Tags ajudam a organizar e categorizar registros do CRM. Cada módulo pode ter até 100 tags, e cada registro pode ter até 10 tags atribuídas. Tags devem ter nomes únicos dentro de um módulo e podem receber cores personalizadas de uma paleta predefinida. Criar uma tag não a aplica a nenhum registro; use ações de atualização separadas para atribuir a tag aos registros.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	O nome da tag a criar. Máximo de 25 caracteres. Não pode conter <, >, vírgulas ou emojis.
color_code	string	Não	Código de cor hexadecimal para a tag. Deve ser uma das 13 cores permitidas: #F17574 (vermelho), #F48435 (laranja), #E7A826 (amarelo), #A8C026 (lima), #63C57E (verde), #1DB9B4 (teal), #57B1FD (azul), #879BFC (índigo), #D297EE (roxo), #FD87BD (rosa), #969696 (cinza), #658BA8 (ardósia), #B88562 (marrom). Padrão: laranja (#F48435).
module_api_name	string	Sim	O nome de API do módulo Zoho CRM no qual criar a tag. Módulos suportados: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices e módulos personalizados. O valor diferencia maiúsculas de minúsculas e deve corresponder exatamente ao nome de API do CRM (ex.: 'Leads' não 'leads' ou 'Lead').

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 metadados de campos do módulo Zoho CRM

ZOHO_GET_MODULE_FIELDS

Recupera metadados de campos de um módulo do Zoho CRM, incluindo nomes de API, tipos de dados, permissões e detalhes de configuração. Use esta ferramenta para descobrir os nomes e tipos de campos corretos antes de criar ou atualizar registros, evitando erros INVALID_DATA. Retorna informações sobre campos padrão, campos personalizados, campos de lookup, opções de picklist e permissões de campo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string	Não	Filtra campos por tipo de uso. Valores: 'all' (campos usados e não usados) ou 'unused' (apenas campos não usados). Se não especificado, retorna todos os campos em uso.
include	string	Não	Inclui detalhes adicionais de permissão na resposta. Use 'allowed_permissions_to_update' para obter permissões de campo padrão (somente leitura, leitura e escrita, oculto).
field_unique_id	string	Não	O ID único de um campo específico a recuperar. Quando fornecido, apenas os metadados daquele campo são retornados. Se não especificado, todos os campos do módulo são retornados.
module_api_name	string	Sim	O nome de API do módulo para recuperar metadados de campos. Exemplos: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', 'Cases', 'Events', 'Calls', etc. Para módulos personalizados, use o nome de API exato como configurado no Zoho CRM.

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 metadados de listas relacionadas do Zoho CRM

ZOHO_GET_RELATED_LISTS

Recupera metadados de listas relacionadas de um módulo do Zoho CRM para descobrir valores corretos de api_name. Use antes de atualizar registros relacionados para evitar erros INVALID_DATA causados por related_list_api_name incorreto. Retorna api_name, display_label, href e outros detalhes para cada lista relacionada disponível no módulo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
layout_id	string	Não	ID de layout opcional para filtrar listas relacionadas por layout específico. Se não especificado, retorna listas relacionadas de todos os layouts do módulo.
module_api_name	string	Sim	O nome de API do módulo para recuperar metadados de lista relacionada. Exemplos: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', etc. Deve ser um nome de API de módulo válido no Zoho CRM.

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 registros relacionados do Zoho CRM

ZOHO_GET_RELATED_RECORDS

Busca registros de lista relacionada (ex.: Notas, Anexos, E-mails) para um registro pai do Zoho CRM usando related_list_api_name. Use ZOHO_GET_RELATED_LISTS primeiro para descobrir o api_name correto da lista relacionada que deseja acessar. Suporta paginação para grandes conjuntos de resultados (até 2.000 registros com page/per_page, ilimitado com page_token).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ids	string	Não	Lista separada por vírgulas de IDs específicos de registros relacionados a recuperar. Use para buscar apenas determinados registros relacionados em vez de todos. Exemplo: '4876876000000636001,4876876000000636002'.
page	integer	Não	Número da página a recuperar (padrão: 1). Sem page_token, apenas os primeiros 2.000 registros são acessíveis usando paginação page/per_page. Número máximo de página é floor(2000/per_page). Não use junto com page_token.
fields	string	Sim	Nomes de API dos campos a recuperar, separados por vírgulas (obrigatório pelo Zoho para esta API). Especifique os nomes dos campos do módulo da lista relacionada cujos detalhes deseja receber. Exemplo: 'Note_Title,Note_Content,Created_Time' para Notas. Os nomes dos campos variam por tipo de lista relacionada.
sort_by	string	Não	Campos válidos para ordenação de registros relacionados: "id", "Created_Time", "Modified_Time".
per_page	integer	Não	Número de registros por página (padrão e máximo: 200). Aplica-se tanto à paginação por page quanto por page_token.
converted	string	Não	Filtro de status de conversão (aplicável a certas listas relacionadas). Valores: "false", "true", "both".
record_id	string	Sim	O identificador único do registro pai para o qual recuperar registros relacionados.
page_token	string	Não	Parâmetro de paginação baseado em token para buscar registros além do limite de 2.000 registros. Use o info.next_page_token da resposta anterior. Não pode ser usado junto com page.
sort_order	string	Não	Ordem de classificação para registros relacionados: "asc" ou "desc".
module_api_name	string	Sim	O nome de API do módulo pai que contém o registro. Exemplos: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', etc.
related_list_api_name	string	Sim	O nome de API da lista relacionada a recuperar (ex.: 'Notes', 'Attachments', 'Emails'). IMPORTANTE: Use a ação ZOHO_GET_RELATED_LISTS primeiro para descobrir o api_name correto. Usar um api_name incorreto resultará em erros INVALID_DATA. Valores de exemplo: 'Notes', 'Attachments', 'Activities', 'Emails', 'Campaigns', 'Products', 'Open_Activities', 'Closed_Activities', 'Invited_Events'.

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 registros do Zoho CRM

ZOHO_GET_ZOHO_RECORDS

Recupera registros de um módulo específico no Zoho CRM. Notas: a paginação discreta (page/per_page) está limitada aos primeiros 2.000 registros; para recuperar registros além desse limite, use paginação baseada em token via page_token da resposta anterior (info.next_page_token). Não use page junto com page_token. Não use cvid junto com sort_by.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ids	string	Não	IDs de registros separados por vírgulas para buscar registros específicos. Ignorado quando page_token é fornecido.
cvid	integer	Não	ID de exibição personalizada para filtrar registros. Não pode ser usado junto com sort_by. Ignorado quando page_token é fornecido.
page	integer	Não	Número da página a recuperar. Sem page_token, apenas os primeiros 2.000 registros são acessíveis. Número máximo de página é floor(2000/per_page). Não use junto com page_token.
fields	string	Não	Nomes de API dos campos a recuperar, separados por vírgulas (máximo 50). Pelo menos um campo deve ser especificado (string vazia não é permitida). Campos comuns: First_Name, Last_Name, Email, Phone, Mobile. Para Leads: Company, Lead_Status, Lead_Source. Para Accounts: Account_Name, Website, Industry. Para Contacts: Account_Name, Mailing_Street. Para Deals: Deal_Name, Amount, Stage, Closing_Date. Nomes de campos inválidos ou de outros módulos silenciosamente produzem colunas ausentes em vez de erros explícitos.
sort_by	string	Não	Campos válidos para ordenação de registros: "id", "Created_Time", "Modified_Time".
per_page	integer	Não	Número de registros por página (padrão e máximo: 200). Aplica-se tanto à paginação por page quanto por page_token.
page_token	string	Não	Parâmetro de paginação baseado em token para buscar registros além do limite de 2.000 registros. Use o info.next_page_token da resposta anterior. Não pode ser usado junto com page.
sort_order	string	Não	Ordem de classificação para registros: "asc" ou "desc".
module_api_name	string	Sim	O nome de API do módulo para recuperar registros. Módulos padrão suportados: Leads, Contacts, Accounts, Deals, Tasks, Events, Calls, Products, Quotes, Sales_Orders, Purchase_Orders, Invoices, Campaigns, Vendors, Price_Books, Cases, Solutions, Notes. IMPORTANTE: 'Activities' NÃO é um módulo suportado — use 'Tasks', 'Events' ou 'Calls'. Deve ser o nome de API exato, não o rótulo de exibição da interface — divergências silenciosamente retornam resultados vazios em vez de erro.

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 usuários do Zoho CRM

ZOHO_GET_ZOHO_USERS

Recupera usuários do Zoho CRM. Use quando precisar buscar informações de usuários como IDs, nomes, e-mails, funções ou status para definir campos de proprietário ou realizar operações relacionadas a usuários em fluxos de trabalho do CRM.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ids	string	Não	Lista separada por vírgulas de IDs de usuários para recuperar usuários específicos. Máximo de 100 IDs de usuários por vez.
page	integer	Não	Número da página para resultados paginados. Padrão: 1.
type	string	Não	Tipo de usuários a recuperar. Valores suportados: 'AllUsers' (todos os usuários, incluindo inativos), 'ActiveUsers' (somente usuários ativos), 'DeactiveUsers' (somente usuários desativados), 'ConfirmedUsers' (usuários que confirmaram conta), 'NotConfirmedUsers' (usuários que não confirmaram conta), 'DeletedUsers' (usuários excluídos), 'ActiveConfirmedUsers' (usuários ativos e confirmados), 'AdminUsers' (usuários com privilégios de administrador), 'ActiveConfirmedAdmins' (administradores ativos e confirmados), 'CurrentUser' (o usuário atualmente autenticado). Se não especificado, retorna todos os usuários ativos e confirmados.
per_page	integer	Não	Número de usuários a recuperar por página. Máximo: 200. Padrão: 200.
if_modified_since	string	Não	Recuperar usuários modificados após este timestamp. Use o formato ISO 8601 (ex.: '2024-01-15T10:00:00+00:00'). Será enviado como o cabeçalho 'If-Modified-Since' para a 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.

Listar módulos do Zoho CRM

ZOHO_LIST_MODULES

Lista todos os módulos disponíveis do Zoho CRM (padrão e personalizados) para selecionar nomes/IDs de API de módulos de forma confiável. Use esta ferramenta antes de chamar outras operações específicas de módulo para garantir a seleção correta de module_api_name e evitar erros INVALID_MODULE. Especialmente útil para descobrir módulos personalizados e seus nomes de API exatos.

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 anexos de um registro do Zoho CRM

ZOHO_LIST_RECORD_ATTACHMENTS

Lista metadados de anexos (id, File_Name, Size, Created_Time, etc.) para um registro específico do Zoho CRM. Use quando precisar identificar anexos antes de baixá-los por outros meios. Retorna apenas metadados, não o conteúdo real dos arquivos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página a recuperar (padrão: 1).
fields	string	Não	Nomes de API dos campos de anexo a recuperar, separados por vírgulas. Campos comuns: id, File_Name, Size, Created_Time, Modified_Time, Owner, Parent_Id, Created_By, Modified_By, $editable, $file_id, $se_module.
per_page	integer	Não	Número de anexos por página (padrão e máximo: 200).
record_id	string	Sim	O ID único do registro para o qual listar os anexos.
module_api_name	string	Sim	O nome de API do módulo que contém o registro. Exemplos: 'Leads', 'Contacts', 'Accounts', 'Deals', etc.

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.

Pesquisar registros no Zoho CRM

ZOHO_SEARCH_ZOHO_RECORDS

Pesquisa registros em um módulo do Zoho CRM usando consultas do lado do servidor. Use quando precisar encontrar registros específicos por critérios, e-mail, telefone ou palavra-chave em vez de listar todos os registros. Evita limites de paginação e realiza filtragem eficiente no servidor.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página a recuperar (padrão: 1). Máximo de 2.000 registros acessíveis pela API de pesquisa.
word	string	Não	Palavra-chave de busca global em múltiplos campos do módulo. Não pode ser usado junto com criteria, email ou phone.
email	string	Não	Busca este endereço de e-mail em todos os campos de e-mail do módulo. Não pode ser usado junto com criteria, phone ou word.
phone	string	Não	Busca este número de telefone em todos os campos de telefone do módulo. Não pode ser usado junto com criteria, email ou word.
fields	string	Não	Nomes de API dos campos a retornar na resposta, separados por vírgulas. Se não especificado, todos os campos são retornados. Exemplo: 'First_Name,Last_Name,Email,Phone'.
criteria	string	Não	Busca avançada usando condições de campo. Formato de condição única: (Field_API_Name:operator:value). Formato de múltiplas condições: ((Field1:operator:value)and/or(Field2:operator:value)). Operadores suportados: equals, starts_with, in, not_equal, greater_equal, greater_than, less_equal, less_than, between. CRÍTICO: o operador 'contains' NÃO é suportado pela API Zoho e causará erros INVALID_QUERY. Para correspondência de substring em campos de texto, use 'equals' (realiza busca de substring). Para campos datetime (ex.: Created_Time, Modified_Time), os valores DEVEM incluir offset de fuso horário no formato yyyy-MM-ddTHH:mm:ss+HH:mm. Máximo de 10 critérios.
per_page	integer	Não	Número de registros por página. Padrão e máximo: 200.
module_api_name	string	Sim	O nome de API do módulo no qual pesquisar. Módulos padrão usam PascalCase (ex.: 'Leads', 'Contacts', 'Accounts', 'Deals'). Módulos personalizados devem usar seu nome de API exato como configurado no Zoho CRM.

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 registros relacionados no Zoho CRM

ZOHO_UPDATE_RELATED_RECORDS

Associa ou atualiza relacionamentos entre registros em diferentes módulos do Zoho CRM. Esta ação cria ou modifica relacionamentos entre um registro pai e registros relacionados. Casos de uso comuns: associar Leads/Contatos a Campanhas (com status de membro), vincular Produtos a Negócios/Cotações/Contas, conectar Contatos a Contas, associar Serviços a Compromissos. Use ZOHO_GET_RELATED_LISTS para descobrir valores válidos de related_list_api_name para seu módulo. Máximo de 100 registros relacionados por chamada de API. Se module_api_name, record_id, related_list_api_name ou IDs de registros filho em data não corresponderem exatamente à configuração de lista relacionada do Zoho CRM, as associações podem ter sucesso silencioso (sem erro retornado) mas o relacionamento não será criado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	array	Sim	Lista de registros relacionados a associar ao registro pai. Cada dicionário deve incluir: 1) 'id' (string, obrigatório): o ID único do registro relacionado a associar. 2) Campos opcionais a atualizar (ex.: 'Member_Status' para membros de campanha). Máximo de 100 registros relacionados por chamada de API. Exemplo: [{'id': '5725767000000327001', 'Member_Status': 'Active'}].
record_id	string	Sim	O identificador único (ID) do registro pai ao qual os registros relacionados serão associados.
module_api_name	string	Sim	O nome de API do módulo pai onde o registro reside. Módulos comuns: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Products', 'Quotes'. Use o nome de API exato do módulo (PascalCase).
related_list_api_name	string	Sim	O nome de API da lista/módulo relacionada para atualizar relacionamentos. Exemplos comuns: 'Campaigns' (para relações Lead-Campanha), 'Products' (para relações Negócio-Produto), 'Contacts' (para relações Conta-Contato). Use a ação ZOHO_GET_RELATED_LISTS para descobrir nomes de API de listas relacionadas válidos para um módulo específico.

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 registro no Zoho CRM

ZOHO_UPDATE_ZOHO_RECORD

Atualiza registros existentes em um módulo específico do Zoho CRM. Suporta a atualização de até 100 registros por chamada de API. Use nomes de API dos campos (não nomes de exibição) para todas as atualizações. O campo 'id' é obrigatório para cada registro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	array	Sim	Lista de dicionários representando os registros a atualizar. Cada registro DEVE incluir o campo 'id' com o ID do registro a atualizar. Atualize até 100 registros por chamada de API. Use nomes de API dos campos como chaves (não nomes de exibição). Para campos de lookup multi-módulo (What_Id, Who_Id), use o formato: {'field_name': {'id': 'record_id', 'module': {'api_name': 'ModuleName'}}}. Exemplo: [{'id': '123456789', 'Last_Name': 'Smith', 'What_Id': {'id': '987654321', 'module': {'api_name': 'Accounts'}}}]. Para atribuição de proprietário, use o nome de API do campo de proprietário (ex.: 'Owner') com valor {'id': '<zoho_user_id>'}. Inclua apenas os campos que pretende modificar — campos não intencionais sobrescrevem dados existentes.
lar_id	string	Não	ID da regra de atribuição a acionar durante a atualização do registro (para módulos aplicáveis como Leads).
trigger	array	Não	Lista de gatilhos de automação a executar durante a atualização. Valores válidos: ['workflow', 'approval', 'blueprint', 'pathfinder', 'orchestration']. Passe um array vazio [] para pular toda automação. Se não especificado, os gatilhos padrão são executados.
module_api_name	string	Sim	O nome de API do módulo no qual atualizar os registros. Módulos padrão usam PascalCase (ex.: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', 'Campaigns'). Módulos personalizados devem usar seu nome de API exato como configurado no Zoho CRM.
skip_feature_execution	array	Não	Funcionalidades a pular durante a atualização. Exemplo: [{'name': 'cadences'}] para pular execução de cadências.
apply_feature_execution	array	Não	Funcionalidades a executar durante a atualização. Exemplo: [{'name': 'layout_rules'}] ou [{'name': 'criteria_validation_rule'}].

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.

Fazer upload de anexo para registro no Zoho CRM

ZOHO_UPLOAD_ATTACHMENT

Faz upload de um arquivo ou anexa uma URL como Anexo a um registro específico do Zoho CRM. Use quando precisar armazenar arquivos (PDFs, documentos, imagens) ou vincular URLs externas na seção de Anexos de um registro. Forneça um arquivo via multipart/form-data ou informe uma attachmentUrl, mas não ambos na mesma requisição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
file	object	Não	Arquivo a fazer upload como anexo. Deve ser fornecido 'file' ou 'attachmentUrl', mas não ambos.
title	string	Não	Título para o anexo. Relevante apenas quando usar 'attachmentUrl'. Este campo é ignorado ao fazer upload de arquivo via 'file'.
record_id	string	Sim	O ID único do registro ao qual anexar o arquivo ou URL.
attachmentUrl	string	Não	URL de um arquivo a anexar como link. Deve ser fornecido 'file' ou 'attachmentUrl', mas não ambos. Ao usar attachmentUrl, você pode opcionalmente fornecer um 'title'.
module_api_name	string	Sim	O nome de API do módulo que contém o registro. Exemplos: 'Leads', 'Contacts', 'Accounts', 'Deals', etc.

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.