extensionUserDefinitions
objects, then
by setting their value through extendedData
objects.
extendedData
.
Such extended data can be of different types and formats (refer to the
UserProperties documentation). Here is an example
with various format values.
/api/v3/users/{id}
API endpoint ({id}
being the ID of the user that should be updated).
extendedData
field on the User.
But they are WRITTEN through passing their values at the root level of the User object.extendedData
User
property will NOT work.
Creating a value for a simple single-value ExtendedData
Updating the value of a simple single-value ExtendedData
Deleting the value of a simple single-value ExtendedData
value
property to null
.
The ExtendedData value ID must be specified.Creating a value for a simple multiple-value ExtendedData
Appending values to a simple multiple-value ExtendedData
Deleting values from a simple multiple-value ExtendedData
Creating a value for a composite single-value ExtendedData
value
property
which in itself is a JSON object setting the value of each of the ExtendedData properties.When creating a value, the ExtendedData id
may be either omitted or set to zero 0
.Updating the value of a composite single-value ExtendedData
Deleting the value of a composite single-value ExtendedData
Appending a value to a composite multiple-value ExtendedData
Deleting some values of a composite multiple-value ExtendedData
/api/v3/extensionuserdefinitions
allows to retrieve more information about the possible entries for list type ExtendedData. The objects returned by this API contain an extensionUserPropertyListEntries
property, which is an array containing useful information about the entries in the list:
id
: numeric value identifying the list entry, which can be inserted into ExtendedData values via the users API;name
: lthe text associated with the list entry, translated into the language of the current user;translation
: the text associated with the list entry, translated into all available languages:
culturedLabels
culture.code
: the language of the translation (“en-US”, “fr-FR”, “es-ES”, etc)value
: the translated text in the specified language