API atual/Referência completa/Newsletter

GETExportar inscritos

Baixa em CSV todos os inscritos ativos da newsletter.

Devolve um arquivo CSV (newsletter_subscribers.csv) com todos os inscritos ativos, sem paginação. O arquivo começa com a marca BOM do UTF-8 para o Excel abrir os acentos corretamente. Não aceita filtros: só quem tem status A entra.

GET/api/v1/admin/newsletter/exportAdmin

Baixa os inscritos ativos em CSV

Rota ligada ao módulo newsletter: com o módulo desligado a resposta é 403. Leitura exige view_newsletter, manage_newsletter ou manage_content.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/newsletter/export" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Arquivo CSV

json

Email,Name,Status,Source,Subscribed At,Created At
maria.souza@example.com,Maria Souza,A,storefront_block,2026-09-21T21:11:00.638673Z,2026-09-21T21:11:00.638673Z

Campos da resposta

Emailstring

Coluna 1: e-mail.

Namestring

Coluna 2: nome (vazio se não informado).

Statusstring

Coluna 3: sempre A.

Sourcestring

Coluna 4: origem da inscrição.

Subscribed Atstring

Coluna 5: inscrição.

Created Atstring

Coluna 6: criação do registro.

Erros

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O administrador não tem o privilégio exigido.	`{"error":"insufficient privileges","privilege_required_any":["view_newsletter","manage_newsletter","manage_content"]}`
500	Falha ao gerar o arquivo. Se o envio já começou, o corpo pode vir cortado.	`{"error":"export failed","detail":"..."}`

Veja também