Last modified on September 11, 2023 at 1:52 pm
Overview
To remove a localized name from a userfield, you can send an HTTP PUT request to the userfield URL with a JSON object containing an updated localizedNames property, omitting the translation you wish to remove.
The localized names property consists of an object whose properties map ISO-639 locale codes to localized values. When updating this property, all localizations you intend to keep must be provided. For example, if you have a userfield with German (de) and Spanish (es) localized names, and you want to remove the German translation, you must still provide the value for the es locale in the new localizedNames property value. Omitting the de value, but providing a value for es, will leave you with the Spanish translation only.
Note that you are not limited to updating one property at a time; all fields that are valid for a particular userfield type may be updated in a single request. All fields not specified will retain their value. See the Userfield Object Reference for a list of all the object’s fields.
Example
This example shows the request-response sequence when clearing all localized names from a userfield.
Request
PUT /dc/api/v5/userfields/8da97a97a92efd18dcbc12876a4510e HTTP/1.1
Host: org.digitalchalk.com
Content-type: application/json
Accept: application/json
{
"localizedNames": {}
}
Response
HTTP/1.1 204 No Content