Atualizar contato no Keap, por uma API

Atualiza os campos enviados e retorna o contato. Campos omitidos mantêm os valores, mas cada lista enviada (email_addresses, phone_numbers, addresses) substitui a lista inteira.

Identificador
keap_update_contact

A chamada

POST https://connect.reportei.com/api/tools/keap_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": "<contact_id>"
  }
}

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âmetroTipoObrigatórioDescrição
contact_idstringSimId of the contact, from List contacts or Create contact.
given_namestringNãoFirst name.
family_namestringNãoLast name.
job_titlestringNãoJob title.
email_addressesarrayNãoEmail addresses, one per slot. Sending this list replaces all the current ones, and an empty list removes them.
phone_numbersarrayNãoPhone numbers, one per slot. Sending this list replaces all the current ones, and an empty list removes them.
addressesarrayNãoPostal addresses, one per kind. Sending this list replaces all the current ones, and an empty list removes them.
websitestringNãoWebsite address.
owner_idstringNãoId of the user who owns the contact, the id field of List users (not global_user_id).
contact_typestringNãoType of the contact as configured in the Keap app, for example Lead or Customer.
birth_datestringNãoBirth date, for example 1990-05-17.

Conexões possíveis

O seu cliente conecta a conta do Keap uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/keap, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/keap_update_contact. Ele vira a definição de tool do seu agente sem conversão.

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.