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

Atualizar um bloco

Altera o tipo, o nome, as propriedades ou a versão de idioma de um bloco existente, identificado pelo id.

Para atualizar um bloco existente, envie uma requisição PUT ao endpoint do bloco com o id na URL. A referência escreve PUT /api/blocks/{block_id}/, por exemplo PUT /api/blocks/42. Inclua os dados do bloco no corpo da requisição de acordo com o Content-Type que você informar. O campo type é obrigatório, mesmo que você só esteja renomeando o bloco.

PUT/api/blocks/{block_id}Admin

Atualizar um bloco existente

Parâmetros de caminho

block_idintegerobrigatório
O identificador único do bloco a atualizar.

Corpo da requisição

typestringobrigatório
Tipo do bloco (por exemplo, "template", "html", "menu").
namestring
Nome do bloco.
propertiesobject
Propriedades específicas do bloco.
lang_codestring
Código do idioma, para lojas multilíngues.

Exemplo de requisição

Esta requisição muda o tipo do bloco para "Template" e atualiza o nome e o caminho do template do bloco de id 42.

bash
curl -u "$EMAIL:$API_KEY" -H "Content-Type: application/json" -X PUT "$BASE_URL/api/blocks/42" -d '{
  "type": "template",
  "name": "Example Template 2",
  "properties": {
    "template": "blocks/static_templates/my_account_links.tpl"
  }
}'
Suporte a vários idiomas

Em lojas com vários idiomas, você pode atualizar o nome do bloco em um idioma específico incluindo o parâmetro lang_code. Por exemplo, ao adicionar "lang_code": "ru" ao JSON, o nome muda apenas no idioma russo.

Resposta

200Bloco atualizado
json
{
  "block_id": "42"
}

Erros

StatusQuando
200 OKO bloco foi atualizado com sucesso
400 Bad RequestParâmetros da requisição inválidos
404 Not FoundO bloco com o id informado não existe

Veja também

  • Obter um bloco, para ler o bloco antes de alterá-lo.
  • Detalhes do bloco, para as propriedades e a estrutura do conteúdo.
Anterior
Criar um bloco
Próxima
Excluir um bloco
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também