テンプレートの削除
リクエスト URL
DELETE https://otp.api.engagelab.cc/v1/template-configs/{templateId}
認証
API 認証の方法については 認証 を参照してください。
リクエスト
リクエストパラメータ
URL 中の {templateId} は削除対象のテンプレート ID を表し、テンプレート作成インターフェースの呼び出し時に呼び出し側が定義したものです。
リクエスト例
リクエストヘッダー
DELETE /v1/template-configs/{templateId} HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
DELETE /v1/template-configs/{templateId} HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
このコードブロックはフローティングウィンドウ内に表示されます
リクエストボディ
なし
レスポンス
レスポンスパラメータ
| フィールド | 型 | 必須/任意 | 説明 |
|---|---|---|---|
| code | Integer | 必須 | エラーコード。0 は成功、それ以外は失敗を意味する |
| message | String | 必須 | レスポンスメッセージ |
レスポンス例
成功レスポンス
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
このコードブロックはフローティングウィンドウ内に表示されます
失敗レスポンス
{
"code": 4001,
"message": "config not exist"
}
{
"code": 4001,
"message": "config not exist"
}
このコードブロックはフローティングウィンドウ内に表示されます
エラーコード
| エラーコード | HTTP コード | 説明 |
|---|---|---|
| 1000 | 500 | 内部エラー |
| 2001 | 401 | 認証失敗。付与されたトークンが正しくない |
| 2002 | 401 | 認証失敗。トークンが期限切れまたは無効化されている |
| 2004 | 403 | この API を呼び出す権限がない |
| 3001 | 400 | リクエストパラメータの形式が不正。JSON の内容がパラメータ形式に準拠しているか確認してください |
| 3002 | 400 | リクエストパラメータが正しくない。リクエストパラメータが要件を満たしているか確認してください |
| 4001 | 400 | テンプレートが存在しない |
