📧 Newsletter (Admin)

📋 Visão Geral

O módulo de Newsletter (Admin) permite que usuários administrativos gerenciem os cadastros de newsletter da loja diretamente pela plataforma de administração.

As newsletters são utilizadas para o envio de comunicações de marketing, campanhas e promoções, direcionadas aos contatos cadastrados.

As operações disponíveis são a listagem paginada dos cadastros e a remoção definitiva de um registro específico.

🔄 Entidades Envolvidas

Newsletter

Representa uma inscrição na lista de comunicações da loja. Cada registro está vinculado a um canal de venda e contém os dados de identificação do assinante.

• id — identificador único da inscrição.
• salesChannelId — ID do canal de venda ao qual a inscrição pertence.
• email — e-mail do assinante.
• name — nome do assinante.
• masked — indica se o e-mail está mascarado (ex.: clientes com privacidade configurada).
• createdAt — data e hora de criação da inscrição.

📌 Notas e Considerações

• Remoção definitiva — ao excluir um cadastro de newsletter pelo painel administrativo, o registro é removido permanentemente. O cadastro do cliente vinculado ao e-mail não é afetado pela exclusão.
• Listagem paginada — a listagem suporta filtros por id e email, além de ordenação por id, email e createdAt.

Listagem de Newsletter

Descrição

Endpoint responsável por retornar uma lista paginada de todos os cadastros de newsletter da loja 📧.

Destinado ao painel administrativo, permite a visualização organizada dos e-mails cadastrados para comunicações de marketing.

A utilização requer autenticação via UserAuth e permissão CUSTOMER_READ, garantindo controle de acesso às informações.

Parâmetros de Query

Headers Obrigatórios

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

1curl --request GET \
2  --url '{{MAIN_URL}}/customers/newsletters?limit=10&offset=0' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI'

Exemplo com Filtros

1curl --request GET \
2  --url '{{MAIN_URL}}/customers/newsletters?limit=10&offset=0&condition[email]=exemplo@email.com&order[0][field]=createdAt&order[0][direction]=desc' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": {
4    "registers": [
5      {
6        "id": 1,
7        "salesChannelId": 1,
8        "email": "joao.silva@email.com",
9        "name": "João Silva",
10        "masked": false,
11        "createdAt": "2026-01-01 01:01:59"
12      },
13      {
14        "id": 2,
15        "salesChannelId": 1,
16        "email": "ana.julia@email.com",
17        "name": "Ana Ju",
18        "masked": false,
19        "createdAt": "2026-01-01 01:01:59"
20      }
21    ],
22    "pagination": {
23      "limit": 10,
24      "offset": 0,
25      "pages": 1,
26      "registers": 2
27    }
28  }
29}

Remoção de Newsletter

Descrição

Endpoint que permite aos usuários administrativos remover um cadastro de newsletter da loja 📧.

A exclusão é definitiva, e o e-mail será removido permanentemente da lista de newsletter.

Ao realizar a remoção, aplicam-se as seguintes regras:

• Remoção definitiva: o cadastro é excluído permanentemente do banco de dados
• Sem efeito no cliente: caso o e-mail esteja vinculado a um cliente, o cadastro do cliente não será afetado

Essa separação garante que a gestão de newsletter não interfira diretamente nos dados cadastrais do cliente.

Parâmetros de Query

Headers Obrigatórios

Parâmetros de URL

Exemplo de Requisição

1curl --request DELETE \
2  --url '{{MAIN_URL}}/customers/newsletters/123' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": true
4}