Configurações

Editar E-mail

Personaliza assunto e texto, ou liga e desliga o aviso

PUT

/v1/emails/{tipo}

Escopo

configuracoes.escrever

O resumo do pedido, o botão e o rodapé da loja entram automaticamente no e-mail.

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.

Parâmetros de caminho

tipostringobrigatóriopath

Tipo do aviso (veja Listar E-mails).

Corpo da requisição

assuntostringbody · application/json

3 a 150 caracteres.

textostringbody · application/json

3 a 3.000 caracteres, com as variáveis.

ativobooleanbody · application/json

false desliga o aviso.

Resposta

200 — 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.
`404`	`nao_encontrado`	O recurso não existe nesta loja.
`404`	`rota_nao_encontrada`	Endereço inexistente na API v1.
`422`	`fornecedor_recusou`	O fornecedor (AliExpress) recusou ou a conta não está conectada; a mensagem traz o motivo.
`404`	`sem_cobranca`	O pedido não tem cobrança em um meio de pagamento.
`404`	`sem_rastreio`	O pedido ainda não tem código de rastreio.
`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 PUT \ --url 'https://api.hoteldaslojas.com.br/v1/emails/recebido' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"assunto": "Recebemos seu pedido #{pedido}!", "ativo": true}'

import os, requests resposta = requests.put( "https://api.hoteldaslojas.com.br/v1/emails/recebido", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "assunto": "Recebemos seu pedido #{pedido}!", "ativo": True }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/emails/recebido'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'PUT', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE'), 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode([ 'assunto' => 'Recebemos seu pedido #{pedido}!', 'ativo' => true ]), ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "tipo": "recebido", "nome": "Pedido recebido", "assunto": "Recebemos seu pedido #{pedido}!", "texto": "Olá, {nome}!\nRecebemos seu pedido e a loja já foi avisada.", "ativo": true, "personalizado": true } }

{ "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" } }