Como enviar consentimento para a Klaviyo via Zapier

O que você vai aprender

Saiba como criar um webhook personalizado do Zapier para enviar consentimento de SMS para a Klaviyo. Você pode modificar facilmente as instruções deste guia para enviar consentimento por e-mail também.

As etapas abaixo vão ajudar você a criar um Zap usando um webhook (também chamado de catch hook) que aciona uma ação de script em Python. O exemplo atualiza o consentimento de marketing por SMS. Incluir um endereço de e-mail na solicitação não inscreve o perfil no marketing por e-mail.

Sobre a integração

Este guia usa uma ação de código do Zapier que executa um script em Python quando o acionador é detectado. Com esta solução, você pode mapear campos para os tipos de dados que os ponto de extremidade do Klaviyo exigem, especificamente os ponto de extremidade de Inscrever perfis e Cancelar inscrição de perfis.

Antes de começar

Configure o SMS no Klaviyo com um número de envio para o país do destinatário de teste. Use um número de celular real e um endereço de e-mail que você controla: testar a ação do código altera o consentimento na sua conta do Klaviyo.

Tenha uma chave de API privada do Klaviyo com permissões de lists:write, profiles:write e subscriptions:write. Veja como gerenciar as chaves de API da sua conta.

Se a sua conta usar restrição de idade por SMS, amplie a solicitação de inscrever-se para incluir age_gated_date_of_birth antes de usar este exemplo. O exemplo abaixo não coleta nem envia uma data de nascimento.

Configurar webhook do Zapier

Para conferir as instruções atuais de configuração do Zapier, consulte os guias sobre gatilhos de webhook e ações de código Python.

1. Faça login na sua conta do Zapier.
2. Na página principal do Zapier, selecione +Criar e, em seguida, selecione Zap.
3. Digite um nome para seu novo Zap (por exemplo, webhook da Klaviyo).
4. Clique na etapa Gatilho e, em seguida, pesquise e selecione Webhooks do Zapier.
   

5. No menu suspenso Evento, selecione Catch Hook.
   

6. Clique em Continuar. Para os dados de teste simples usados neste guia, deixe Escolher uma chave filha para separar em branco e clique em Continuar novamente.
7. Selecione a aba Teste.
8. Copie o URL do webhook que o Zapier fornece para que você envie suas solicitações.
   

9. Configure o aplicativo que coleta consentimento para enviar alterações de consentimento para este URL de webhook, incluindo os campos email, phone_number e sms_consent usados abaixo. Siga a documentação desse aplicativo para configurar o webhook de saída.
10. Antes de testar, você precisará enviar dados de teste para o seu webhook. Confira nosso guia sobre Como enviar dados de teste para o Zapier para mais informações. Ao enviar dados de teste, certifique-se de formatar números de telefone no formato E.164, incluindo o sinal de + e o código do país.
11. Depois de enviar os dados de teste para o webhook, clique em Testar acionamento (na guia Teste).
    

12. Se a solicitação for bem-sucedida, você verá uma mensagem de sucesso e os dados de teste serão preenchidos abaixo da mensagem de sucesso, semelhante ao exemplo abaixo:
    

13. Quando o gatilho estiver funcionando, clique em Continuar com o registro selecionado.

Configurar a ação do Zapier

1. Adicione uma etapa de ação e depois pesquise e selecione Code by Zapier.
   

2. No menu suspenso Evento, selecione Executar Python.
   

3. Clique em Continuar.

Configure o mapeamento de campos e crie a lógica do script

1. Em Dados de entrada, mapeie email, phone_number e sms_consent para os campos correspondentes nos seus dados de teste. Insira as chaves exatamente como mostrado. O campo name nos dados de exemplo não é usado por este script.
   

Envie true somente para um aceite explícito de marketing por SMS. Envie false somente para uma solicitação de cancelar inscrição de SMS: isso revoga o consentimento de marketing por SMS em toda a sua conta e remove o perfil da lista selecionada. Não use false para um valor de consentimento vazio ou desconhecido.

1. Adicione um script como o abaixo na caixa de código:
   

import requests

sms_consent = str(input_data.get("sms_consent", "")).strip().lower()
if sms_consent not in ("true", "false"):
    raise ValueError("sms_consent must be true or false")

# Configure the SMS marketing subscribe or unsubscribe request.
if sms_consent == "true":
    url = "https://a.klaviyo.com/api/profile-subscription-bulk-create-jobs/"
    payload = {
        "data": {
            "type": "profile-subscription-bulk-create-job",
            "attributes": {
                "profiles": {
                    "data": [{
                        "type": "profile",
                        "attributes": {
                            "email": input_data["email"],
                            "phone_number": input_data["phone_number"],
                            "subscriptions": {
                                "sms": {"marketing": {"consent": "SUBSCRIBED"}}
                            }
                        }
                    }]
                }
            },
            "relationships": {
                "list": {"data": {"type": "list", "id": "LIST_ID"}}
            }
        }
    }
else:
    url = "https://a.klaviyo.com/api/profile-subscription-bulk-delete-jobs/"
    payload = {
        "data": {
            "type": "profile-subscription-bulk-delete-job",
            "attributes": {
                "profiles": {
                    "data": [{
                        "type": "profile",
                        "attributes": {
                            "email": input_data["email"],
                            "phone_number": input_data["phone_number"],
                            "subscriptions": {
                                "sms": {"marketing": {"consent": "UNSUBSCRIBED"}}
                            }
                        }
                    }]
                }
            },
            "relationships": {
                "list": {"data": {"type": "list", "id": "LIST_ID"}}
            }
        }
    }

headers = {
    "accept": "application/json",
    "revision": "2026-07-15",
    "content-type": "application/json",
    "Authorization": "Klaviyo-API-Key your-private-api-key"
}

response = requests.post(url, json=payload, headers=headers, timeout=10)
response.raise_for_status()

# Zapier requires an output object.
output = {
    "status_code": response.status_code,
    "response text": response.text
}

1. Substitua your-private-api-key pela sua chave de API privada da Klaviyo.
   

1. Substitua LIST_ID em ambos os locais pelo ID da sua lista Klaviyo. No Klaviyo, acesse Público > Listas e segmentos, abra a lista e selecione Configurações > Detalhes para copiar o ID da lista.
2. Revise Configurações > Consentimento > Processo de opt-in dessa lista. Para se inscrever sem uma confirmação, selecione Inscrição em uma etapa e clique em Salvar. Com inscrição em duas etapas, conclua qualquer confirmação de SMS enviada ao seu número de teste antes de verificar a inscrição.
3. Clique em Continuar e, em seguida, clique em Testar etapa.
4. Verifique se a saída mostra status_code 202. Isso significa que a Klaviyo aceitou a solicitação para processamento; isso não confirma que a atualização do consentimento foi concluída. É esperado um corpo de resposta vazio.
   

5. No Klaviyo, verifique se o seu perfil de teste foi adicionado à lista selecionada. Depois, abra o perfil e confirme se ele está inscrito no marketing por SMS. Se uma mensagem de confirmação foi enviada, conclua essa confirmação primeiro.
   

6. Teste o caminho de cancelar inscrição com o mesmo perfil de teste: envie uma nova solicitação de webhook com sms_consent definido como false, selecione esse novo registro de acionamento no Zapier e teste a etapa de código novamente. Confirme no Klaviyo que o perfil cancelou inscrição no marketing por SMS e foi removido da lista selecionada.
7. Depois que ambos os testes forem bem-sucedidos, clique em Publicar para publicar seu Zap. Se um teste não for bem-sucedido, confira nossas dicas de solução de problemas para questões comuns.

Adapte o exemplo para consentimento de e-mail

Para uma versão somente por e-mail deste Zap:

1. Mapeie uma entrada email_consent da sua origem e, em seguida, substitua sms_consent por email_consent em todo o script. Use true para uma adesão explícita ao marketing por e-mail e false para uma solicitação de cancelar inscrição de e-mail.
2. Em ambos os payloads de solicitação, substitua a chave sms em subscriptions por email. Mantenha o campo email do destinatário e remova o campo phone_number de ambos os payloads.
3. Teste ambos os caminhos de consentimento de e-mail antes de publicar a versão de e-mail do seu Zap. Verifique o consentimento de e-mail no perfil e conclua qualquer confirmação de opt-in de e-mail enviada durante o teste de inscrever-se.

Dicas para solucionar problemas

A seguir, estão alguns problemas comuns que você pode encontrar ao configurar o webhook do Zapier. Se você encontrar qualquer outro problema, pode entrar em contato com a Klaviyo Community para receber mais orientações.

Fim de linha ao analisar literal de string

Se você vir esse erro, então está faltando uma aspa em torno de uma das suas variáveis. Verifique o ID da lista e a chave de API privada para garantir que eles estejam entre aspas dos dois lados.

SyntaxError: sintaxe inválida

Se você vir esse erro, verifique se as quebras de linha, o recuo, as aspas e os colchetes do código correspondem ao exemplo. Em particular, as atribuições url e payload devem estar em linhas separadas. As linhas que começam com # são comentários válidos de Python e não precisam ser removidas.

Recursos adicionais