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.

Atualizar objeto de dados

patch

/data_objects/objects/{type_name}/{object_id}

Use este endpoint para mesclar atributos em um objeto de dados existente.

Importante

Os objetos de dados estão disponíveis para todos os clientes. No entanto, seu espaço de trabalho precisa estar provisionado para Contas antes de você usar este endpoint. Para solicitar o provisionamento, acesse Configurações de dados > Contas e preencha o questionário. Para saber mais, consulte Ativar Contas.

Pré-requisitos

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

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}/{object_id}.

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

Parâmetros de solicitação

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

Parâmetro	Obrigatório	Tipo de dados	Descrição
`attributes`	Obrigatório	Objeto	Campos de nível superior a serem mesclados
`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. Se omitido, o nome de exibição existente é mantido

Exemplo de solicitação

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

Exemplo de carga útil da solicitação

{
  "attributes": {
    "credits": 750
  }
}

Exemplo de solicitação cURL

Este exemplo atualiza o atributo credits em acct-123 e mantém os demais atributos do registro inalterados.

curl --location --request PATCH 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{ "attributes": { "credits": 750 } }'

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. O objeto attributes reflete o resultado da mesclagem.

{
  "data_object": {
    "type_name": "account",
    "object_id": "acct-123",
    "attributes": { "name": "Acme", "credits": 750 }
  }
}

Parâmetros de resposta

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

Parâmetro	Obrigatório	Tipo de dados	Descrição
`data_object`	Obrigatório	Objeto	Registro do objeto de dados atualizado
`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 do objeto após a mesclagem

Erros

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

Status	Causa	Orientação
`400`	Erro de validação	Confirme se todos os campos em `attributes` existem no esquema do tipo e usam o tipo de dados correto.
`404`	Tipo não encontrado ou objeto não encontrado	Confirme se `type_name` e `object_id` existem no 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 está bloqueada pela lista de permissões	Confirme se a chave tem a permissão `data_objects.update` e, caso a lista de permissões esteja configurada, se o seu IP de origem está incluído nela.
`429`	Limite de frequência excedido	Tente novamente após o horário indicado em `X-RateLimit-Reset` e reduza a frequência das solicitações.

New Stuff!