同期のトリガ
post
/cdi/integrations/{integration_id}/sync
このエンドポイントを使用して、特定の統合の同期をトリガします。
note:
このエンドポイントを使用するには、cdi.integration_sync
権限を持つAPI キーを生成する必要があります。
レート制限
This endpoint has a rate limit of 20 requests per minute.
パスパラメータ
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
integration_id |
必須 | 文字列 | 統合ID. |
リクエスト例
1
2
3
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
は、以下のレスポンスボディを返す可能性があります。
1
2
3
{
"message": "success"
}
トラブルシューティング
次の表に、返される可能性のあるエラーと関連するトラブルシューティング手順を示します。
エラー | トラブルシューティング |
---|---|
400 Invalid integration ID |
integration_id が有効であることを確認します。 |
404 Integration not found |
指定された統合ID には統合が存在しません。統合ID が有効であることを確認します。 |
429 Another job is in progress |
この統合のために現在実行中の同期があります。同期が完了したら、再試行します。 |
その他のステータスコードと関連するエラーメッセージについては、Fatal errors & responsesを参照してください。