Skip to content

Criar bloco de conteúdo

post

/content_blocks/create

Use esse endpoint para criar um bloco de conteúdo.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão content_blocks.create.

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da API.

Corpo da solicitação

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
4
5
6
7
{
  "name": (required, string) Must be less than 100 characters,
  "description": (optional, string) The description of the Content Block. Must be less than 250 character,
  "content": (required, string) HTML or text content within Content Block,
  "state": (optional, string) Choose `active` or `draft`. Defaults to `active` if not specified,
  "tags": (optional, array of strings) Tags must already exist
}

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
name Obrigatória String Nome do bloco de conteúdo. Deve ter menos de 100 caracteres.
description Opcional String Descrição do bloco de conteúdo. Deve ter menos de 250 caracteres.
content Obrigatória String Conteúdo HTML ou de texto no bloco de conteúdo.
state Opcional String Escolha active ou draft. O padrão é active se não for especificado.
tags Opcional Matriz de strings As tags já devem existir.

Exemplo de solicitação

1
2
3
4
5
6
7
8
9
10
curl --location --request POST 'https://rest.iad-01.braze.com/content_blocks/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "name": "content_block",
  "description": "This is my Content Block",
  "content": "HTML content within block",
  "state": "draft",
  "tags": ["marketing"]
}'

Resposta

1
2
3
4
5
6
{
  "content_block_id": (string) Your newly generated block id,
  "liquid_tag": (string) The generated block tag from the Content Block name,
  "created_at": (string) The time the Content Block was created in ISO 8601,
  "message": "success"
}

Solução de problemas

A tabela a seguir lista os possíveis erros retornados e as etapas de solução de problemas associadas.

Erro Solução de problemas  
Content cannot be blank    
Content must be a string Certifique-se de que seu conteúdo esteja encapsulado entre aspas ("").  
Content must be smaller than 50kb O conteúdo do seu bloco de conteúdo deve ser menor que 50 KB no total.  
Content contains malformed liquid O Liquid fornecido não é válido ou não pode ser analisado. Tente novamente com Liquid válido ou entre em contato com o suporte.  
Content Block cannot be referenced within itself    
Content Block description cannot be blank    
Content Block description must be a string Certifique-se de que a descrição do bloco de conteúdo esteja encapsulada entre aspas ("").  
Content Block description must be shorter than 250 characters    
Content Block name cannot be blank    
Content Block name must be shorter than 100 characters    
Content Block name can only contain alphanumeric characters Os nomes dos blocos de conteúdo podem incluir qualquer um dos seguintes caracteres: as letras (maiúsculas ou minúsculas) A a Z, os números 0 a 9, os traços - e os sublinhados _. Não pode conter caracteres não alfanuméricos, como emojis, !, @, ~, & e outros caracteres “especiais”.  
Content Block with this name already exists Tente um nome diferente.  
Content Block state must be either active or draft    
Tags must be an array As tags devem ser formatadas como uma matriz de strings, por exemplo, ["marketing", "promotional", "transactional"].  
All tags must be strings Confira se as tags estão entre aspas ("").  
Some tags could not be found Para adicionar uma tag ao criar um bloco de conteúdo, a tag já deve existir na Braze.  
New Stuff!