Newsletter

A newsletter é a lista de pessoas que aceitaram receber e-mails promocionais da loja. Esta seção cobre as duas metades: os inscritos (consultar, exportar, apagar) e as campanhas (escrever o e-mail, enviar para todos os inscritos ativos e acompanhar o resultado). As inscrições chegam pela vitrine e pelo cadastro; não são criadas por esta API.

Como funciona

Uma campanha percorre estes estados, todos devolvidos como letra no campo status.

Os inscritos têm outros estados:

Conceitos importantes

Confirmação dupla

Quando a loja exige confirmação, a pessoa se inscreve, recebe um e-mail e só passa a A ao clicar no link. Até lá fica P e não recebe campanhas.

Cancelamento

Todo e-mail de campanha leva no fim um link "Cancelar inscrição" exclusivo de cada destinatário. Quem clica passa a U. A API não reativa um inscrito: a pessoa precisa se inscrever de novo.

Estado em letra

Tanto campanhas quanto inscritos devolvem status como uma letra. Para filtrar a lista de inscritos você pode usar a palavra (active, pending, unsubscribed, bounced) ou a letra; na lista de campanhas use a letra.

Campanha da loja e de seller

Campanhas sem vendor_id são da loja. Sellers também têm campanhas próprias, que aparecem na lista com vendor_id. Use marketplace_only=true para ver só as da loja.

Privacidade

E-mails e nomes são dados pessoais. Exporte, guarde e apague conforme a LGPD.

Endpoints

Erros comuns

• Criar a campanha com scheduled_at e esperar que ela saia sozinha: nada dispara por data.
• Chamar send duas vezes: a segunda responde 400 can only send draft campaigns.
• Tentar editar uma campanha depois do envio: só rascunho aceita edição.
• Filtrar campanhas com status=sent achando que cobre "enviando": ambas viram A; use S para as que estão enviando.
• Esperar 404 ao consultar com um id que não é UUID: algumas rotas respondem 500.
• Esperar que o CSV de exportação traga os cancelados: ele traz só os ativos.

Próximos passos