Atualizar relacionamento de objeto

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

Importante

Custom Objects está atualmente em acesso antecipado. Seu espaço de trabalho precisa estar ativado antes que as permissões de chave de API de Custom Objects apareçam em Configurações > Chaves de API.

Pré-requisitos

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

Limite de frequência

Este endpoint está no bucket de escrita de Custom 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 /custom_objects/objects/{type_name}/{external_id}/object_relationships.

Parâmetros de requisição

A tabela a seguir lista e descreve os parâmetros do corpo da requisição JSON para o endpoint /custom_objects/objects/{type_name}/{external_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 de requisição

1
2
3
4
5
6
7
{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_external_id": "acct-456",
  "anchor": "source",
  "attributes": {}
}

Exemplo de requisição cURL

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

1
2
3
4
5
6
7
8
9
10
curl --location --request PATCH 'https://rest.iad-01.braze.com/custom_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_external_id": "acct-456",
  "anchor": "source",
  "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_custom_object": {
      "type_name": "account",
      "external_id": "acct-456",
      "attributes": { "name": "Child Account" }
    },
    "attributes": {}
  }
}

Parâmetros de resposta

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

Erros

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