KAkameleoon
CustomData

Partially update the custom data

Update several fields of the custom data. To use optionalFields check out this guide.

patch/custom-datas/{customDataId}

Request

Path parameters

customDataIdinteger required

The ID of the custom data object

Query parameters

optionalFieldsstring[]

Request body

adobeAnalyticsVariableNamestring

Variable name of the Adobe Analytics

advancedProposedValuesstring

Enables to set values for targeting conditions in the form of a JS table

customEvalCodestring

Custom code that will be executed

descriptionstring
gtmVariableNamestring

Variable name of the Google Tag Manager

isConstantboolean

Indicates whether the custom data is a constant

isFiltrableVentilableboolean

Indicates whether custom data should be filtered and marked as available for breakdown

isLocalOnlyboolean

Indicates whether the data is only stored on the user’s device.

learnableboolean

Indicates whether this data should be included in Kameleoon machine learning

method'ADOBE_ANALYTICS' | 'CLIENT' | 'CUSTOM_CODE' | 'GTM' | 'SDK' | 'TC' | 'TEALIUM'

Method through which a custom data will be transmitted

namestring

Name of the given custom data.

tagsstring

Field to store tags that are associated with this record

tcVariableNamestring

Variable name for the tag commander data layer, if it is selected as a transmission method

tealiumVariableNamestring

Variable name for the Tealium, if it is selected as a transmission method

type'BOOLEAN' | 'COUNT_LIST' | 'LIST' | 'NUMBER' | 'STRING' | 'UNIQUE'

Type of data to be retrieved

Response

OK

adobeAnalyticsVariableNamestring

Variable name of the Adobe Analytics

advancedProposedValuesstring

Enables to set values for targeting conditions in the form of a JS table

createdByIdinteger

Account Id of the creator of the custom data

customEvalCodestring

Custom code that will be executed

dateCreatedstring date-time

Date and time a record is created

dateModifiedstring date-time

Date and time a record is modified

descriptionstring

Description of the custom data

format'BOOLEAN' | 'NUMBER' | 'STRING'

Custom data value format

gtmVariableNamestring

Variable name of the Google Tag Manager

idinteger

Unique Id of the custom data.

indexinteger
isConstantboolean

Indicates if the custom data is a constant

isFiltrableVentilableboolean

Indicates if custom data should be filtered and marked as available for breakdown

isLearnableboolean

Indicates if this data should be included in Kameleoon machine learning

isLocalOnlyboolean

Indicates if the custom data is only stored on the user's device.

method'ADOBE_ANALYTICS' | 'CLIENT' | 'CUSTOM_CODE' | 'GTM' | 'SDK' | 'TC' | 'TEALIUM' required

Method through which a custom data will be transmitted

modificationDatestring date-time

Date and time a record is modified (Deprecated, use dateModified instead)

namestring required

Name of the custom data

siteCodestring

System generated unique code to identify a website.
This is an optional field that is included in the request body

siteIdinteger required

Id of the project this record belongs

tagsstring

Tags that belong to this record

tcVariableNamestring

Name of the tag commander data layer, if it is selected as a transmission method

tealiumVariableNamestring

Name of the Tealium, if it is selected as a transmission method

type'COUNT_LIST' | 'LIST' | 'UNIQUE'

Custom data type. Custom data can be presented as a single value (UNIQUE), or a list of values (LIST), ​​or a countable list of values (COUNT_LIST)

Changes

No recorded changes to this operation across all 1 revision of this API.