オブジェクトリレーションシップの置換

このエンドポイントを使用して、オブジェクトリレーションシップを作成または置換します。

重要

カスタムオブジェクトは現在早期アクセス段階です。カスタムオブジェクトのAPIキー権限が設定 > APIキーに表示されるには、ワークスペースを有効にする必要があります。

前提条件

このエンドポイントを使用するには、custom_objects.object_relationships.update 権限を持つ APIキーが必要です。

レート制限

このエンドポイントはカスタムオブジェクト書き込みバケットに含まれており、デフォルトの制限は1分あたり50リクエストです。

パスパラメーター

次の表は、/custom_objects/objects/{type_name}/{external_id}/object_relationships エンドポイントのパスパラメーターの一覧と説明です。

リクエストパラメーター

次の表は、/custom_objects/objects/{type_name}/{external_id}/object_relationships エンドポイントのJSONリクエストボディパラメーターの一覧と説明です。

リクエスト例

このセクションには、サンプルのJSONペイロードとサンプルのcURLリクエストが含まれています。

サンプルリクエストペイロード

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

サンプルcURLリクエスト

この例では、acct-123 と acct-456 の間の subaccount リレーションシップを置換し、以前保存されていた属性をすべて上書きします。

1
2
3
4
5
6
7
8
9
10
curl --location --request PUT '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": {}
}'

レスポンス

このセクションには、成功レスポンスの例とレスポンスフィールドが含まれています。

成功レスポンスの例

ステータスコード 200 は、次のレスポンスボディを返す可能性があります。

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": {}
  }
}

レスポンスパラメーター

次の表は、成功レスポンスに含まれるフィールドの一覧と説明です。

エラー

次の表は、このエンドポイントで発生する一般的なエラーとその解決方法の一覧です。