DELETE/directory/custom-fields/{customFieldId}

カスタムフィールドを削除する。

  • カスタムフィールドに入力されている値は全て非同期で削除される。

注意
この API は2026年7月下旬を目処に提供終了を予定しています。今後は ユーザーカスタムプロパティの削除 を使用してください。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

directory

HTTP Request

DELETEhttps://www.worksapis.com/v1.0/directory/custom-fields/{customFieldId}

Path Parameters

ParameterTypeDescription
customFieldId string 

カスタムフィールドを特定する ID

  • カスタムフィールド ID (customFieldId)
  • カスタムフィールドの ExternalKey (externalKey:{customFieldExternalKey})

required
example : customfd-fc09-4a57-ab38-03dc6c425e09 

Query Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID (既定値: 認可ドメイン ID)


example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 204

No Content

HTTP 404

Not Found