Atualizar atividade da campanha de e-mail no Constant Contact, por uma API
Atualiza a atividade primary_email de uma campanha em status DRAFT ou DONE. Ela substitui as propriedades: envie o remetente, assunto, preheader e listas atuais, de Obter atividade da campanha de e-mail, junto com as mudanças, pois o que ficar de fora é apagado. html_content e physical_address_in_footer são mantidos quando não enviados.
- Identificador
- constant_contact_update_email_campaign_activity
A chamada
POST https://connect.reportei.com/api/tools/constant_contact_update_email_campaign_activity/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"campaign_activity_id": "<campaign_activity_id>",
"from_name": "<from_name>",
"from_email": "<from_email>",
"reply_to_email": "<reply_to_email>",
"subject": "<subject>"
}
}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 |
|---|---|---|---|
| campaign_activity_id | string | Sim | Id of the activity with role primary_email, from Get email campaign or Create email campaign. |
| contact_list_ids | array | Não | Ids of the lists that receive the email, from List contact lists. Required before scheduling, unless the activity uses a segment. |
| segment_ids | array | Não | The segment that receives the email, as returned by Get email campaign activity. Send it back to keep it. Never together with contact_list_ids. |
| from_name | string | Sim | Sender name shown to contacts. |
| from_email | string | Sim | Sender address, a confirmed email address of the account. |
| reply_to_email | string | Sim | Address that receives the replies, a confirmed email address of the account. |
| subject | string | Sim | Subject of the email. |
| preheader | string | Não | Short summary shown after the subject in the inbox. |
| html_content | string | Não | New HTML body, only for format_type 5. Keep [[trackingImage]] inside the body element so opens and clicks are reported. |
| physical_address_in_footer | object | Não | Address of the sender shown in the footer. state_code is required when country_code is US. |
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_email_campaign_activity. 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.
- Atualizar contatoPUTAtualiza 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.
- 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.
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.
