Obter objeto personalizado

Use este endpoint para retornar um objeto personalizado.

Importante

Custom Objects está atualmente em acesso antecipado. Seu espaço de trabalho deve ser ativado antes que as permissões de chave de API de Custom Objects apareçam em Configurações > Chaves de API.

Pré-requisitos

Para usar este endpoint, você precisa de uma chave de API com a permissão custom_objects.read.

Limite de frequência

Este endpoint está no bucket de leitura de Custom Objects com um limite padrão de 50 solicitações por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho para o endpoint /custom_objects/objects/{type_name}/{external_id}.

Exemplo de solicitação

Esta seção inclui um exemplo de carga útil de parâmetros de caminho e um exemplo de solicitação cURL.

Exemplo de carga útil da solicitação

Use este objeto JSON como referência para os parâmetros de caminho desta solicitação.

1
2
3
4
{
  "type_name": "account",
  "external_id": "acct-123"
}

Exemplo de solicitação cURL

Este exemplo recupera o registro da conta acct-123 e seus atributos armazenados.

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Resposta

Esta seção inclui um exemplo de resposta bem-sucedida e os campos da resposta.

Exemplo de resposta bem-sucedida

O código de status 200 pode retornar o seguinte corpo de resposta.

1
2
3
4
5
6
7
{
  "custom_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Acme", "industry": "software" }
  }
}

Parâmetros de resposta

A tabela a seguir lista e descreve os campos em uma resposta bem-sucedida.

Erros

A tabela a seguir lista erros comuns para este endpoint e como resolvê-los.