Atualizar contato no Constant Contact, por uma API
Atualiza um contato substituindo seus campos principais: email_address, nomes, job_title, company_name, birthday e anniversary omitidos ficam vazios, então envie também os valores atuais, obtidos em Listar contatos. Subrecursos omitidos são mantidos, e o que é enviado substitui o atual.
- Identificador
- constant_contact_update_contact
A chamada
POST https://connect.reportei.com/api/tools/constant_contact_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>",
"update_source": "Account"
}
}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 | string | Sim | Id of the contact, from List contacts. |
| update_source | string | Sim | Who makes the change: Account when the account user changes it, Contact when the person asked for it. A deleted contact comes back only with Account.Valores: Account, Contact |
| email_address | object | Não | Email address of the contact. permission_to_send explicit or implicit is allowed only when the person agreed to receive emails; unsubscribed opts the contact out, with an optional opt_out_reason. |
| first_name | string | Não | First name of the contact. |
| last_name | string | Não | Last name of the contact. |
| job_title | string | Não | Job title of the contact. |
| company_name | string | Não | Company where the contact works. |
| birthday_month | integer | Não | Month of the birthday, 1 to 12. Send it together with birthday_day. |
| birthday_day | integer | Não | Day of the birthday, 1 to 31. Send it together with birthday_month. |
| anniversary | string | Não | Anniversary date, such as when the contact became a customer, as YYYY-MM-DD or MM/DD/YYYY. |
| phone_numbers | array | Não | Up to 3 phone numbers. When sent, they replace the current ones. |
| street_addresses | array | Não | Up to 3 street addresses, each with its kind. When sent, they replace the current ones. |
| list_memberships | array | Não | Ids of all the lists the contact should be in, from List contact lists, up to 50. When sent, the contact leaves the lists that are not in it. The current lists come from List contacts with include list_memberships. |
Conexões possíveis
O seu cliente conecta a conta do Constant Contact 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/constant_contact, 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/constant_contact_update_contact. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Constant Contact
- Listar contatosGETLista os contatos da conta, sem os excluídos por padrão, com filtro opcional por e-mail, lista, status ou data. A resposta traz contacts e, quando há mais, _links.next.href com o cursor da próxima página.
- Criar contatoPOSTCria um contato e o retorna com seu contact_id. Envie create_source e pelo menos email_address, first_name ou last_name. Um e-mail que já existe na conta responde 409.
- Listar listas de contatosGETLista as listas de contatos com list_id, name e description. Uma conta tem até 1000 listas, e uma página traz até 1000.
- Criar lista de contatosPOSTCria uma lista de contatos vazia e a retorna com seu list_id. Um nome já usado por outra lista responde 409.
- Listar campanhas de e-mailGETLista as campanhas de e-mail, da atualizada mais recentemente para a mais antiga, com campaign_id, name, type e current_status, incluindo as excluídas (Removed). Até 500 por página; alcance as mais antigas com before_date e after_date. Os ids das atividades vêm de Obter campanha de e-mail.
- Obter campanha de e-mailGETRetorna uma campanha de e-mail com name, current_status e campaign_activities. O campaign_activity_id com role primary_email é o que as ferramentas de atividade usam.
- Criar campanha de e-mailPOSTCria uma campanha de e-mail em rascunho com conteúdo HTML próprio e a retorna com campaign_activities, onde está a atividade primary_email. Para enviá-la, defina as listas com Atualizar atividade da campanha de e-mail e use Agendar atividade da campanha de e-mail.
- Obter atividade da campanha de e-mailGETRetorna uma atividade de campanha de e-mail: remetente, assunto, preheader, contact_list_ids ou segment_ids, format_type e current_status. html_content e physical_address_in_footer só vêm quando pedidos em include.
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.
