# KeyUpdateParameters

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**branch** | **str** | specify the branch to use | [optional] 
**name** | **str** | Key name | [optional] 
**description** | **str** | Key description (usually includes contextual information for translators). Send an empty string or `null` to clear the description; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional] 
**plural** | **bool** | Indicates whether key supports pluralization | [optional] 
**use_ordinal_rules** | **bool** | Indicates whether key uses ordinal rules for pluralization | [optional] 
**name_plural** | **str** | Plural name for the key (used in some file formats, e.g. Gettext) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional] 
**data_type** | **str** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional] 
**tags** | **str** | List of tags separated by comma to be associated with the key. | [optional] 
**max_characters_allowed** | **int** | Max. number of characters translations for this key can have. | [optional] 
**screenshot** | **bytearray** | Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional] 
**remove_screenshot** | **bool** | Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional] 
**unformatted** | **bool** | Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats. | [optional] 
**xml_space_preserve** | **bool** | Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats. | [optional] 
**original_file** | **str** | Original file attribute. Used in some formats, e.g. XLIFF. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional] 
**localized_format_string** | **str** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional] 
**localized_format_key** | **str** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. | [optional] 
**custom_metadata** | **object** | Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value. | [optional] 
**excluded_in_locales** | **List[str]** | Locales for which translations of this key are excluded from exports. Pass an empty array to clear exclusions.  | [optional] 
**format_value_type** | **str** | Override of the value type for the key in the export. Most useful for formats like Android XML that distinguish string vs. plural resources.  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)