Criar nota no Keap, por uma API

Adiciona uma nota a um contato e a retorna. user_id é obrigatório, e title ou type também.

Identificador
keap_create_note

A chamada

POST https://connect.reportei.com/api/tools/keap_create_note/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>",
    "user_id": "<user_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.
user_idstringSimId of the user writing the note, the id field of List users (not global_user_id).
titlestringNãoTitle of the note. Required when type is left out.
textstringNãoContent of the note.
typestringNãoKind of note, one of Appointment, Call, Email, Fax, Letter or Other in Keap Max and Pro, or a value configured by the admin in Keap Classic. Required when title is left out.
is_pinnedbooleanNãoPins the note to the top of the contact.

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_create_note. 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.