bright, fresh software
Downloads  |  Buy

limelm.feature.edit

Edit an existing custom license field. Note that if you want to set the license field values for existing product keys, use the limelm.pkey.setDetails function.

Arguments

api_key (Required)
Your API application key. Your api key is available on your settings page.
feature_id (Required)
The id of the license field you'll be editing. You can get the license field ID by examining the URL in your browser. For instance, from the URL http://wyday.com/limelm/version/42/edit-feature/ you can see the license field ID is 42. Also, the license field id is returned when you call the limelm.feature.add web API function.
name (Optional)
The new name of the license field. Maximum 255 characters.
required (Optional)
Whether this license field will be required to be filled out when a new product key is created. Possible values are "true" and "false". If this parameter isn't present (or is invalid) it will default to "true".
ta_readable (Optional)
Whether this license field will be readable from your application using the TurboActivate function GetFeatureValue(). Possible values are "true" and "false". If this parameter isn't present (or is invalid) it will default to "true".
description (Optional)
The description of the license field that will appear when you create and edit product keys. Maximum 255 characters.
default_val (Optional)
Set a default value that this custom license field will have if the value is left blank when creating new product keys.
default_dt_relative (Optional)
If this argument is set to "pkey_created" and the "type" is "date_time", then you can use relative times for the "default_val". The relative time must be in the form [+ | -] N [days | months | years | minutes | hours]. Examples of relative times:
  • + 22 days
  • - 1 months
  • + 2 years
If you're missing the leading +/- symbol then the value will be rejected and an error will be returned. If this "default_dt_relative" argument is set to anything other than "pkey_created" then the argument will be ignored.

Example Response

This method has no specific response - It returns an empty success response if it completes without error.

Error Codes

100: Invalid API Key
The API key passed was not valid or has expired.
101: Method "xxx" not found
The requested method was not found.
108: The version id is missing.
The version id was not specified.
118: Your account is in dormant mode. Re-enable your account.
You cannot generate product keys when your account is in dormant mode. Re-enable your account and you will no longer get this error.
125: The "name" parameter must exist and it must be less than 255 characters long.
Make sure your license field name is greater than 0 characters and less than 255.
126: Please enter a new field name (FeatureName already exists).
You can't have multiple features with the same name. Use a unique field name.
127: The license field doesn't exist or you don't have access to it.
Check to make sure you have access to the license field id you've passed in.
142: Service currently unavailable
The requested service is temporarily unavailable.
150: The "description" parameter must be less than 255 characters long.
If you're using a description it must be 255 characters or less.
154: Relative time is missing the preceding plus / minus sign.
The default value must be preceded by a "+" or "-".
155: The unit provided is not valid. Valid units are "days", "months", "years", "minutes", "hours".
Provide the valid unit for the relative default value.