VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Blocos

Excluir um bloco

Remove um bloco da loja de forma permanente, pelo id; depois disso o bloco não pode ser recuperado.

Este endpoint remove um bloco da sua loja de forma permanente. Use-o com cuidado, porque um bloco excluído não pode ser recuperado. Você envia o id do bloco no caminho e, quando o bloco é removido, recebe 204 No Content, sem corpo.

DELETE/api/blocks/{block_id}Admin

Excluir um bloco

Parâmetros de caminho

block_idintegerobrigatório
O identificador único do bloco que você quer excluir.

Exemplo de requisição

Esta requisição exclui o bloco de id 42.

bash
curl -u "$EMAIL:$API_KEY" -X DELETE "$BASE_URL/api/blocks/42"

Erros

StatusQuando
204 No ContentO bloco foi excluído com sucesso
404 Not FoundO bloco informado não existe
Atenção

Excluir um bloco é permanente e não pode ser desfeito. Tenha um backup ou certeza de que quer remover o bloco antes de prosseguir.

Notas de implementação

  • Antes de excluir um bloco, confirme que nenhum outro componente da loja o referencia.
  • Verifique se o bloco está em uso em algum layout ou página, para evitar problemas inesperados de exibição.
  • Para testes, talvez seja melhor desativar o bloco temporariamente em vez de excluí-lo.
  • Se o bloco tiver conteúdo importante, exporte ou faça backup desse conteúdo antes de excluí-lo.

Veja também

  • Obter um bloco, para inspecionar um bloco antes de removê-lo.
  • Criar um bloco, para adicionar um novo.
Anterior
Atualizar um bloco
Próxima
Blocos e idiomas
Nesta página
  • Exemplo de requisição
  • Erros
  • Notas de implementação
  • Veja também