Marketing

Editar Promoção

Altera só os campos enviados

PATCH

/v1/promocoes/{id}

Escopo

marketing.escrever

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

idintegerobrigatóriopath

Identificador do promoção.

Corpo da requisição

…body · application/json

Os mesmos campos da criação.

Resposta

200 — objeto { "dados": {...} } com um Promoção.

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 PATCH \ --url 'https://api.hoteldaslojas.com.br/v1/promocoes/98' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"ativo": false}'

import os, requests resposta = requests.patch( "https://api.hoteldaslojas.com.br/v1/promocoes/98", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "ativo": False }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

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

{ "dados": { "id": 98, "nome": "Leve 3 pague 2", "tipo": "leve_pague", "categorias": [], "leve": 3, "pague": 2, "quantidade_minima": null, "percentual": null, "valor_minimo": null, "inicio": null, "fim": "2026-11-30T23:59:59-03:00", "ativo": false, "criado_em": "2026-10-28T02:52:31-03:00" } }

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