Visão Geral

Através da API de Newsletter você pode gerenciar os inscritos na newsletter da loja: listar, ver os detalhes, cadastrar, editar e excluir inscritos.

Estas páginas são guias práticos. A referência completa de cada campo, tipo e schema está no simulador online:

Swagger UIapi.toplojas.com.br

🔄 Fluxo típico

Um fluxo comum de integração da newsletter costuma seguir esta ordem:

1. Listar os inscritos, filtrando por status ou por nome/e-mail.

2. Consultar os detalhes de um inscrito específico.

3. Cadastrar um novo inscrito na newsletter.

4. Editar os dados de um inscrito (por exemplo, ativar ou desativar).

5. Excluir um inscrito quando necessário.

🧭 Endpoints de Newsletter

Ação	Método	Rota
Listar e filtrar inscritos	GET	/newsletter/
Detalhes de um inscrito	GET	/newsletter/{Codigo}/
Cadastrar inscrito	POST	/newsletter/
Editar inscrito	PUT	/newsletter/{Codigo}/
Excluir inscrito	DELETE	/newsletter/{Codigo}/

🏷️ Status do inscrito

O campo Status indica se o inscrito está ativo ou não na newsletter:

Valor	Significado
A	Ativado
D	Desativado