Atualizar contato no Freshdesk, por uma API
Atualiza um contato: envie só os campos a mudar, e tags e other_emails como as listas completas que o contato deve manter. Contatos bloqueados ou excluídos retornam 405.
- Identificador
- freshdesk_update_contact
A chamada
POST https://connect.reportei.com/api/tools/freshdesk_update_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"contact_id": 1
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| contact_id | integer | Sim | Id of the contact, from List contacts or the requester_id of a ticket. |
| name | string | Não | Name of the contact. |
| string | Não | Primary email address, unique among contacts. | |
| phone | string | Não | Telephone number. |
| mobile | string | Não | Mobile number. |
| unique_external_id | string | Não | External id of the contact, the id in your own system, unique among contacts. |
| other_emails | array | Não | Full list of additional email addresses the contact should have, current ones included. |
| company_id | integer | Não | Id of the primary company of the contact, from Search companies. |
| view_all_tickets | boolean | Não | true lets the contact see all the tickets of the company. |
| job_title | string | Não | Job title. |
| address | string | Não | Address. |
| description | string | Não | Short description of the contact. |
| language | string | Não | Language code. Only with the Multiple Language feature. |
| time_zone | string | Não | Time zone name. Only with the Multiple Time Zone feature. |
| tags | array | Não | Full list of tags the contact should have, current ones included. |
| custom_fields | object | Não | Custom field values keyed by the name of each contact custom field, as they appear in custom_fields of List contacts. Dates go as YYYY-MM-DD. |
Conexões possíveis
O seu cliente conecta a conta do Freshdesk uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Usuário e senha
O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia por POST /api/customer-toolkits, sem tela.
Na conexão, o cliente informa também {domain}: o endereço da conta dele na API do app.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/freshdesk_update_contact. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Freshdesk
- Listar ticketsGETLista tickets, os mais recentes primeiro por padrão. Sem updated_since voltam só os tickets criados nos últimos 30 dias, e spam ou excluídos só vêm com filtro.
- Buscar ticketsGETBusca tickets com uma query de filtro, por exemplo por status, prioridade, agente, grupo, tag ou campo personalizado. Devolve total e results, 30 tickets por página.
- Obter ticketGETDevolve um ticket com status, priority, requester_id, responder_id, group_id, tags, custom_fields e description.
- Criar ticketPOSTCria um ticket. Identifique o solicitante com requester_id, email, phone ou unique_external_id; um email ou phone ainda não existente no Freshdesk cria o contato.
- Atualizar ticketPUTAtualiza um ticket: envie só os campos a mudar, e tags como a lista completa que o ticket deve manter. Status 4 resolve e 5 fecha o ticket.
- Listar conversas do ticketGETLista as respostas e notas de um ticket, com body (HTML), body_text, private, incoming, user_id e source (0 resposta, 2 nota). As páginas são numeradas a partir de 1.
- Criar resposta no ticketPOSTResponde ao solicitante de um ticket. O Freshdesk envia a resposta por e-mail ao solicitante, então ela fica visível ao cliente.
- Criar nota no ticketPOSTAdiciona uma nota a um ticket. As notas são privadas por padrão, visíveis só aos agentes; com private false o solicitante também a vê.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
