Custom Attributesの削除

Prev Next

VPC環境で利用できます。

使用しなくなったか、不要な Custom Attributesの Profileを削除します。

Profileの削除条件は次の通りです。

削除できるかどうか Profileの状態
可能
  • registered: 登録完了
  • completed: 使用可能
  • failed: 失敗
不可
  • pending: 待機中
  • in_progress: 作成中
参考

削除できない場合はエラーメッセージが返されます。削除可能な条件で再試行してください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
DELETE /profile/custom-attributes/{profile_id}

リクエストヘッダ

NCLUE APIで共通して使用されるヘッダの詳細は、NCLUEのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
profile_id String Required Profile ID

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request DELETE 'https://nclue.apigw.ntruss.com/api/v1/profile/custom-attributes/{profile_id}' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
profile_id String - Profile ID

レスポンスステータスコード

NCLUEで共通して使用されるレスポンスステータスコードの詳細は、NCLUEのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "profile_id": "a7f4f996-****-****-****-b0531230e17e"
}