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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id | integer | Sim | ID of the subscriber, from List subscribers. |
| email_address | string | Sim | Email address of the subscriber: the current one, or a new one to change it. |
| first_name | string | Não | First name of the subscriber. |
| fields | object | Não | Custom 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
- Listar inscritosGETLista os inscritos com id, e-mail, nome, estado e campos personalizados, apenas os ativos por padrão. Busque um por email_address. A resposta traz subscribers e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Criar inscritoPOSTCria um inscrito ativo. Quando o e-mail já pertence a um inscrito, atualiza o nome desse inscrito em vez disso. Não adiciona tag: use Apply tag em seguida.
- Listar tagsGETLista as tags com id, nome e data de criação. A resposta traz tags e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Criar tagPOSTCria uma tag e a retorna com seu id. Quando já existe uma tag com o mesmo nome, sem diferenciar maiúsculas, retorna essa tag em vez de uma duplicada.
- Aplicar tagPOSTAplica uma tag a um inscrito existente, encontrado pelo e-mail. As automações da conta que começam com essa tag rodam para o inscrito. Crie o inscrito antes com Create subscriber.
- Listar formuláriosGETLista os formulários e landing pages com id, nome, tipo e URL de incorporação, apenas os ativos por padrão. A resposta traz forms e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Listar segmentosGETLista os segmentos com id e nome. Os segmentos são criados no app do Kit, e seus ids definem o público de um broadcast em subscriber_filter. A resposta traz segments e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Listar broadcastsGETLista os broadcasts com id, assunto, conteúdo, status, send_at, segmentação e template de e-mail. A resposta traz broadcasts e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
