Tools do folk
As 13 operações do folk que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar gruposGETLista os grupos do workspace com id e nome. Os grupos contêm pessoas, empresas e negócios. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Listar campos personalizados do grupoGETLista os campos personalizados de um grupo para pessoas, empresas ou um tipo de objeto, com nome, tipo e as opções dos campos de seleção. Em pessoa ou empresa, cada campo do tipo objectField é um tipo de objeto do grupo, como Deals, e seu nome é o objectType das tools de objeto.
- Listar pessoasGETLista as pessoas do workspace com id, nomes, e-mails, telefones, cargo, empresas, grupos e valores dos campos personalizados. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Criar pessoaPOSTCria uma pessoa, opcionalmente em grupos e vinculada a empresas. O folk mescla duplicatas em segundo plano, o que pode sobrescrever parte dos dados enviados. Uma pessoa sem grupo só aparece na busca do folk.
- Atualizar pessoaPATCHAtualiza uma pessoa, alterando apenas os campos enviados. Uma lista (groups, companies, emails, phones, addresses, urls) substitui a atual, então envie-a completa. Deixar um grupo de fora remove a pessoa dele, junto com os valores dos campos personalizados nesse grupo.
- Listar empresasGETLista as empresas do workspace com id, nome, setor, e-mails, telefones, URLs, grupos e valores dos campos personalizados. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Criar empresaPOSTCria uma empresa, opcionalmente em grupos. Os nomes são únicos no workspace: um nome existente devolve essa empresa em vez de criar outra. Uma empresa sem grupo só aparece na busca do folk.
- Atualizar empresaPATCHAtualiza uma empresa, alterando apenas os campos enviados. Uma lista (groups, emails, phones, addresses, urls) substitui a atual, então envie-a completa. Deixar um grupo de fora remove a empresa dele, junto com os valores dos campos personalizados nesse grupo. Um nome já usado por outra empresa falha.
- Listar objetosGETLista os negócios, ou os objetos de outro tipo, de um grupo, com id, nome, pessoas e empresas vinculadas e valores dos campos personalizados, como o Status do negócio. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink. Um objectType desconhecido responde 404 com os tipos de objeto do grupo.
- Criar objetoPOSTCria um negócio, ou um objeto de outro tipo, em um grupo. As pessoas e empresas vinculadas já precisam estar no grupo, ou o folk as ignora. Um nome de campo personalizado desconhecido faz a requisição inteira falhar com 422.
- Atualizar objetoPATCHAtualiza um negócio ou outro objeto, alterando apenas os campos enviados. people e companies substituem as listas atuais, então envie-as completas. Mover um negócio no funil é uma mudança do campo personalizado Status.
- Listar notasGETLista as notas do workspace com conteúdo, visibilidade, autor, data de criação e a pessoa, empresa ou objeto a que cada uma pertence. query busca no conteúdo. A próxima página vem do cursor dentro de pagination.nextLink; a última página não tem nextLink.
- Criar notaPOSTAdiciona uma nota a uma pessoa, uma empresa ou um objeto, como um negócio. O conteúdo aceita Markdown.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
