同期をトリガー

post

/cdi/integrations/{integration_id}/sync

このエンドポイントを使用して、特定のインテグレーションのシンクをトリガーします。

note:

このエンドポイントを使用するには、cdi.integration_sync 権限を持つAPI キーを生成する必要があります。

レート制限

パスパラメータ

パラメータ	required	データ型	説明
`integration_id`	必須	string	統合 ID。

リクエスト例

curl --location --request POST 'https://rest.iad-03.braze.com/cdi/integrations/00000000-0000-0000-0000-000000000000/sync' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

成功応答の例

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

{
  "message": "success"
}

トラブルシューティング

次のテーブルに、返される可能性のあるエラーと、関連するトラブルシューティングステップを示します。

エラー	トラブルシューティング
`400 Invalid integration ID`	`integration_id` が有効であることを確認します。
`404 Integration not found`	指定された統合 ID には統合が存在しません。統合ID が有効であることを確認します。
`429 Another job is in progress`	この統合のために現在実行されている同期があります。同期が完了したら、もう一度試してください。

その他のステータスコードと関連するエラーメッセージについては、「致命的なエラーと応答」を参照してください。

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

GitHub でこのページを編集

New Stuff!