Skip to content

Substituir objeto de dados

put

/data_objects/objects/{type_name}/{external_id}

Use este endpoint para criar ou substituir um objeto de dados com semântica de substituição completa de atributos.

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 Data Objects com um limite padrão de 50 requisições por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho para o endpoint /data_objects/objects/{type_name}/{external_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
external_id Obrigatório String Identificador do objeto

Parâmetros de requisição

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

Parâmetro Obrigatório Tipo de dados Descrição
attributes Obrigatório Objeto Atributos completos do objeto. Campos omitidos serão apagados
display_name Opcional String Rótulo de exibição para o objeto. Quando o tipo possui um campo de origem de nome de exibição, o valor desse campo tem precedência. O padrão é external_id

Exemplo de requisição

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

Exemplo de carga útil da requisição

1
2
3
4
5

{
  "attributes": {
    "name": "Updated Account"
  }
}

Exemplo de requisição cURL

Este exemplo substitui os atributos armazenados em acct-123 pelos da carga útil. Se nenhum registro com esse identificador existir, esta requisição o criará.

1
2
3
4
5
6
7
8

curl --location --request PUT '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": {
    "name": "Updated Account"
  }
}'

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. Este endpoint retorna 200 independentemente de a requisição ter criado ou substituído o objeto.

1
2
3
4
5
6
7

{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Updated Account" }
  }
}

Parâmetros de resposta

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

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

Erros

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

Status Causa Orientação
400 Erro de validação Confirme que cada campo em attributes existe no esquema do tipo e usa o tipo de dados correto.
404 Tipo não encontrado (data-object-type-not-found) Confirme que type_name existe no espaço de trabalho e corresponde exatamente ao nome de máquina.
422 Limite de registros atingido (data-object-record-limit-exceeded) quando esta requisição criaria um novo objeto Reduza a contagem de objetos para o 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 requisição está bloqueada pela lista de permissões Confirme que a chave possui data_objects.update e que o IP de origem está na lista de permissões da chave, se configurada.
429 Limite de frequência excedido Tente novamente após X-RateLimit-Reset e reduza a frequência de requisições.
New Stuff!