Atualizar relacionamento de objeto

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

Importante

O Data Objects está disponível para todos os clientes, mas seu espaço de trabalho precisa ser 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 mais detalhes, consulte Ativar contas.

Pré-requisitos

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

Limite de frequência

Este endpoint está no bucket de escrita de 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}/object_relationships.

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}/object_relationships.

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
6

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}

Exemplo de requisição cURL

Este exemplo mescla atributos no relacionamento subaccount existente entre acct-123 e acct-456, mantendo inalterados os atributos que você omitir.

1
2
3
4
5
6
7
8
9

curl --location --request PATCH 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}'

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
8
9
10
11

{
  "object_relationship": {
    "rel_kind": "subaccount",
    "to_data_object": {
      "type_name": "account",
      "object_id": "acct-456",
      "attributes": { "name": "Child Account" }
    },
    "attributes": {}
  }
}

Parâmetros de resposta

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

Erros

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