Atualizar inscrito no Kit, por uma API

Atualiza o e-mail, o nome ou os campos personalizados de um inscrito. Uma chave de campo personalizado que não existe na conta faz a requisição falhar.

Identificador
kit_update_subscriber

A chamada

POST https://connect.reportei.com/api/tools/kit_update_subscriber/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": 1,
    "email_address": "<email_address>"
  }
}

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
idintegerSimID of the subscriber, from List subscribers.
email_addressstringSimEmail address of the subscriber: the current one, or a new one to change it.
first_namestringNãoFirst name of the subscriber.
fieldsobjectNãoCustom field values to change, keyed by the field key, for example last_name, not Last Name. List subscribers shows the keys in the fields of each subscriber, and a key that is not a custom field of the account is refused.

Conexões possíveis

O seu cliente conecta a conta do Kit 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/kit, 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/kit_update_subscriber. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Kit

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

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