Substituir objeto de dados

Use este endpoint para criar um objeto de dados ou substituir todos os atributos de um objeto existente.

Importante

O Data Objects 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 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 do Data Objects, com um limite padrão de 1.000 requisiçõ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âmetros de requisição

A tabela a seguir lista e descreve os parâmetros do corpo da requisição JSON do endpoint /data_objects/objects/{type_name}/{object_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 não existir nenhum registro com esse identificador, esta requisição o cria.

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 tanto quando a requisição cria quanto quando substitui o objeto.

1
2
3
4
5
6
7

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

Parâmetros de resposta

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

Erros

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