> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifly.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# APIのエラーコードとレスポンス形式

> Notifly APIの主なレスポンス形式と、HTTPステータスコードごとの対応方法を説明します。

## レスポンス形式

一般的なエラーレスポンスには、`success`、`code`、`error`が含まれます。

```json theme={null}
{ "success": false, "code": 400, "error": "Bad request: エラーの詳細" }
```

一部のエンドポイントでは、エラーの詳細だけを返します。

```json theme={null}
{ "error": "Bad request: エラーの詳細" }
```

リクエストが成功し、成功フラグが返る場合の例です。

```json theme={null}
{ "success": true }
```

エンドポイントによっては、`data`と`error`を返します。

```json theme={null}
{ "data": "...", "error": null }
```

## HTTPステータスコード

| コード | 名前 | 意味 | 対応方法 |
| -: | - | - | - |
| 200 | OK | リクエストが成功しました。 | レスポンスの内容は該当エンドポイントのスキーマを参照してください。 |
| 400 | Bad Request | 本文、クエリ、パスの必須値が不足しているか、値や形式が不正です。 | リクエストを修正して再送します。 |
| 401 | Unauthorized | トークンが無効か期限切れ、または認証に失敗しました。 | `POST /authenticate`でトークンを再発行してから再送します。 |
| 403 | Forbidden | プロジェクトやリソースにアクセスする権限がありません。 | 権限を確認し、必要に応じてアクセスを申請します。 |
| 404 | Not Found | キャンペーンやユーザーなど、対象のリソースが見つかりません。 | リソースのIDとパスを確認します。 |
| 405 | Method Not Allowed | エンドポイントがそのHTTPメソッドに対応していません。 | リファレンスで対応するメソッドを確認します。 |
| 409 | Conflict | リソースが重複しているか、現在の状態と操作が競合しています。 | 対象の状態を確認してから再送します。 |
| 413 | Payload Too Large | リクエストや一括処理のサイズが上限を超えています。 | データを分割するか、リクエスト本文を小さくします。 |
| 429 | Too Many Requests | 一定時間内のリクエスト数が上限を超えました（レート制限）。 | 指数バックオフで再試行します。 |
| 500 | Internal Server Error | サーバーで処理が完了しませんでした。 | 繰り返しても問題のない操作は再試行します。解消しない場合はサポートにお問い合わせください。 |
| 501 | Not Implemented | 指定の操作は利用できません。 | 対応状況をエンドポイントのリファレンスで確認します。 |

## エラーレスポンスの例

### 400 リクエストが不正な場合

```json theme={null}
{ "success": false, "code": 400, "error": "Bad request: eventName missing" }
```

### 401 認証に失敗した場合

```json theme={null}
{ "success": false, "code": 401, "error": "Unauthorized: Invalid token" }
```

### 413 リクエストが大きすぎる場合

```json theme={null}
{ "success": false, "code": 413, "error": "Payload too large" }
```

### 500 サーバーでエラーが発生した場合

```json theme={null}
{ "success": false, "code": 500, "error": "Internal Server Error" }
```

## エラーへの対処

* トークンの期限が切れている場合は、`POST /authenticate`で再発行してから再送します。
* 1回のリクエストで処理できる件数を超える場合は、データを分割します。たとえば、一部の操作では1回あたり1,000件まで送信できます。
* `429`や一部の`500`など、再試行できるエラーには指数バックオフを使用します。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.