Marketing

Inscrever na Newsletter

Inscreve um e-mail (a pessoa confirma pelo e-mail)

POST

/v1/newsletter

Escopo

marketing.escrever

A pessoa recebe o e-mail de confirmação da loja e só entra na lista depois de clicar. E-mail já confirmado: 200 com a inscrição.

Autorização

Authorizationstringobrigatórioheader

Chave da API no formato Bearer hdl_live_.... Crie no painel da loja em Integração › API e webhooks. Saiba mais.

Corpo da requisição

emailstringobrigatóriobody · application/json

Resposta

201 — objeto { "dados": ... } (veja o exemplo).

Erros possíveis

HTTP	código	quando
`401`	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
`401`	`chave_invalida`	Chave inexistente ou revogada.
`403`	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.
`422`	`fornecedor_recusou`	O fornecedor (AliExpress) recusou ou a conta não está conectada; a mensagem traz o motivo.
`422`	`imagem_invalida`	A imagem não pôde ser baixada ou não é JPG, PNG, WEBP ou GIF de até 5 MB.
`422`	`validacao`	Campos inválidos: veja o objeto "campos".

curl --request POST \ --url 'https://api.hoteldaslojas.com.br/v1/newsletter' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"email": "[email protected]"}'

import os, requests resposta = requests.post( "https://api.hoteldaslojas.com.br/v1/newsletter", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "email": "[email protected]" }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/newsletter'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE'), 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode([ 'email' => '[email protected]' ]), ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "id": 14, "email": "[email protected]", "origem": "api", "situacao": "aguardando_confirmacao", "inscrito_em": "2026-10-28T03:01:00-03:00", "confirmado_em": null, "descadastrado_em": null } }

{ "erro": { "codigo": "sem_permissao", "mensagem": "Esta chave não tem o escopo \"pedidos.ler\". Crie uma chave com esse escopo no painel da loja (Integração › API).", "request_id": "req_95f4a872c180063c" } }