Skip to content

Ver informações do bloco de conteúdo

get

/content_blocks/info

Use este endpoint para consultar informações dos seus Content Blocks existentes.

See me in Postman

Pré-requisitos

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

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.

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
content_block_id Obrigatória String O identificador do bloco de conteúdo.

Você pode encontrá-lo listando as informações do bloco de conteúdo por meio de uma chamada de API ou acessando a página Chaves de API, rolando até a parte inferior e pesquisando o identificador de API do seu bloco de conteúdo.
include_inclusion_data Opcional booleano Quando definido como true, a API retorna o identificador de API da variação de mensagem de Campaigns e Canvas em que esse bloco de conteúdo está incluído, para ser usado em chamadas subsequentes. Os resultados excluem Campaigns ou Canvas arquivados ou excluídos.

Exemplo de solicitação

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/content_blocks/info?content_block_id={{content_block_id}}&include_inclusion_data=false' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "content_block_id": (string) the Content Block identifier,
  "name": (string) the name of the Content Block,
  "content": (string) the content in the Content Block,
  "description": (string) the Content Block description,
  "content_type": (string) the content type, html or text,
  "tags": (array) An array of tags formatted as strings,
  "created_at": (string) The time the Content Block was created in ISO 8601,
  "last_edited": (string) The time the Content Block was last edited in ISO 8601,
  "inclusion_count" : (integer) the inclusion count,
  "inclusion_data": (array) the inclusion data,
  "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 Block ID cannot be blank Verifique se um bloco de conteúdo está listado na sua solicitação e está entre aspas ("").
Content Block ID is invalid for this workspace Esse bloco de conteúdo não existe ou está em uma conta de empresa ou espaço de trabalho diferente.
Content Block has been deleted—content not available Esse bloco de conteúdo, embora possa ter existido anteriormente, foi excluído.
Include Inclusion Data—error Esse parâmetro aceita apenas valores booleanos (true ou false). Verifique se o valor de include_inclusion_data não está entre aspas (""), o que faz com que o valor seja enviado como uma string. Consulte os parâmetros de solicitação para mais detalhes.
New Stuff!