Ir para o conteúdo

Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

Criar objeto de dados

post

/data_objects/objects/{type_name}

Use este endpoint para criar um objeto de dados para um tipo.

Importante

O recurso Objetos de dados está disponível para todos, mas seu espaço de trabalho precisa estar provisionado para Contas antes que você possa usar este endpoint. Para solicitar o provisionamento, acesse Configurações de dados > Contas e preencha o questionário. Para mais detalhes, consulte Ativar Contas.

Pré-requisitos

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

Limite de frequência

Este endpoint está no bucket de escrita de Objetos de dados, com um limite padrão de 1.000 solicitações por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho do endpoint /data_objects/objects/{type_name}.

Parâmetro	Obrigatório	Tipo de dados	Descrição
`type_name`	Obrigatório	String	Nome de máquina do tipo de objeto de dados

Parâmetros de solicitação

A tabela a seguir lista e descreve os parâmetros do corpo da solicitação JSON para o endpoint /data_objects/objects/{type_name}.

Parâmetro	Obrigatório	Tipo de dados	Descrição
`object_id`	Obrigatório	String	Identificador do objeto, único dentro do tipo. Pode conter apenas letras, números, hifens e sublinhados, e deve ter no máximo 250 caracteres
`attributes`	Obrigatório	Objeto	Valores indexados por nome de campo, validados em relação ao esquema do tipo
`display_name`	Opcional	String	Rótulo de exibição do objeto. Quando o tipo tem um campo de origem para o nome de exibição, o valor desse campo tem precedência. O padrão é `object_id`

Exemplo de solicitação

Esta seção inclui uma carga útil JSON de exemplo e uma solicitação cURL de exemplo.

Carga útil de solicitação de exemplo

{
  "object_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}

Solicitação cURL de exemplo

Este exemplo cria um registro account com o identificador acct-new e define os atributos name e industry.

curl --location --request POST 'https://rest.iad-01.braze.com/data_objects/objects/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "object_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}'

Resposta

Esta seção inclui uma resposta de sucesso de exemplo e os campos da resposta.

Exemplo de resposta de sucesso

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

{
  "data_object": {
    "type_name": "account",
    "object_id": "acct-new",
    "attributes": { "name": "New Account", "industry": "software" }
  }
}

Parâmetros de resposta

A tabela a seguir lista e descreve os campos de uma resposta de sucesso.

Parâmetro	Obrigatório	Tipo de dados	Descrição
`data_object`	Obrigatório	Objeto	Registro do objeto de dados criado
`data_object.type_name`	Obrigatório	String	Nome de máquina do tipo de objeto de dados
`data_object.object_id`	Obrigatório	String	Identificador do objeto de dados
`data_object.attributes`	Obrigatório	Objeto	Atributos armazenados do objeto, indexados por nome de campo

Erros

A tabela a seguir lista os erros comuns deste endpoint e como resolvê-los.

Status	Causa	Orientação
`400`	Campo de atributo desconhecido ou tipo de atributo inválido	Confirme se todos os campos em `attributes` existem no esquema do tipo e usam o tipo de dados correto.
`404`	Tipo não encontrado (`data-object-type-not-found`)	Confirme se `type_name` existe no espaço de trabalho e corresponde exatamente ao nome de máquina.
`409`	Objeto duplicado (`duplicate-data-object`)	Use um `object_id` diferente ou use `PUT` para substituir o objeto existente.
`422`	Limite de registros atingido (`data-object-record-limit-exceeded`)	Reduza a quantidade de objetos do tipo ou entre em contato com o suporte da Braze sobre os limites do seu espaço de trabalho.
`401`	Chave da API REST ausente ou inválida	Verifique se o cabeçalho `Authorization` usa `Bearer YOUR_REST_API_KEY` e se a chave está ativa.
`403`	A chave de API não tem permissão ou a solicitação foi bloqueada pela lista de permissões	Confirme se a chave tem `data_objects.create` e se o seu IP de origem está na lista de permissões da chave, caso ela esteja configurada.
`429`	Limite de frequência excedido	Tente novamente após `X-RateLimit-Reset` e reduza a frequência de solicitações.

New Stuff!