Request Personalization

Request personalized content for data derived from Salesforce Data Cloud.

POST /personalization/decisions

  • /personalization/v1/decisions

Media type: application/json

ParameterTypeDescription
contextObjectDetails regarding the context from which the request is taking place. Einstein Personalization records the context provided as an extension of Personalization Record in the Personalization Record Data Lake Object (DLO) for this request.
personalizationPointsArray
personalizationPoints.idStringThe core ID of a personalization point. Optional if name is provided.
personalizationPoints.nameStringThe API name of a personalization point. Optional if id is provided.
personalizationPoints.decisionIdStringOptional ID of the specific decision that must be returned without rule evaluation (for testing purpose)
profileObjectA Data Cloud Hot Layer Profile. If a profile is provided, the API always uses this profile and skips retrieving the profile from Data Cloud.
executionFlagsArray of StringsEnumerated values:
  • TestMode: Indicates whether the call is operating in test mode. In this mode, no outputs are recorded to the data lake.
  • ContextOnly: Indicates that a call must not look up a profile.

Media type: application/json

ParameterTypeDescription
personalizationsArray
personalizations.personalizationIdStringThe response ID.
personalizations.personalizationPointIdStringThe core identifier for the personalization point used in this request.
personalizations.personalizationPointNameStringThe API name identifier for the personalization point used in this request. This identifier is a reflection of what was passed in the request.
personalizations.dataArrayAn array of content objects matching the expected schema of the Personalization Point.
personalizations.attributesObjectPersonalization Attribute values by Attribute Developer Name.
personalizations.diagnosticsArrayDiagnostic information on errors. Available only for authenticated requests.
diagnosticsArrayDiagnostic information on errors. Available only for authenticated requests.
diagnostics.codeStringThe error code. Available only for authenticated requests.
diagnostics.descriptionStringThe detailed message describing the error. Available only for authenticated requests.
requestIdStringUnique identifier for this request and response.

Details regarding the context from which the request is taking place. Schema to match, or be an extension of, a Personalization Record. Einstein Personalization records the context provided as an extension of Personalization Record in the Personalization Record Data Lake Object (DLO) for this request.

ParameterTypeDescription
individualIdStringThe individual ID to be associated with a Data Cloud Profile.
unifiedIndividualIdStringOptional Unified Individual ID to be associated with a Data Cloud Profile. This ID isn't used for profile lookup. It's only used to enable accurate experimentation partitioning in cases that don’t require a profile lookup.
dataspaceStringThe data space that defines the boundary of a personalization context.
anchorIdStringThe anchor ID to be used by Personalizers referencing a DMO that the end user is interacting with.
anchorTypeStringThe anchor type to be used by Personalizers.
correlationIdStringOptional ID used for attribution involving multiple personalization requests where a future engagement can contain this ID and is attributed to more than one personalization.
messageIdAnyOptional ID representing an individual outbound message.
requestUrlStringOptional URL used to automatically parse data such as UTM parameters.
ParameterTypeDescription
personalizationIdStringThe ID of the response.
personalizationPointIdStringThe core identifier for the personalization point used in the request.
personalizationPointNameStringThe API name identifier for the personalization point used in the request. This identifier is a reflection of what was passed in the request.
dataArrayAn array of Content Objects matching the expected schema of the Personalization Point.
data.personalizationContentIdStringThe identifier for a Personalization Content Record.
attributesObjectPersonalization Attribute values by Attribute Developer Name.
diagnosticsArrayDiagnostic information on errors.
diagnostics.codeStringThe error code
diagnostics.descriptionStringThe detailed message describing the error.
ParameterTypeDescription
idStringThe core ID of a personalization point. Optional if name is provided.
nameStringThe API name of a personalization point. Optional if id is provided.
decisionIdStringOptional ID of the specific decision that must be returned without rule evaluation (for testing purpose).

A request for one or more personalizations to be made for an individual. If values conflict due to duplicate keys within context, events, and profile, context takes precedence.

ParameterTypeDescription
contextObjectRequired. Details regarding the context from which the request is taking place. Schema to match, or be an extension of, a Personalization Record. Context provided as an extension of Personalization Record is recorded in the Personalization Record Data Lake Object (DLO) for this request.
personalizationPointsArrayRequired
personalizationPoints.idStringThe core ID of a personalization point. Optional if name is provided.
personalizationPoints.nameStringThe API name of a personalization point. Optional if id is provided.
personalizationPoints.decisionIdStringOptional ID of the specific decision that must be returned without rule evaluation (for testing purpose).
profileObjectA Data Cloud Hot Layer Profile. If a profile is provided, the API always uses this profile and skips retrieving the profile from Data Cloud.
executionFlagsArray of StringsEnumerated values:
  • TestMode: Indicates whether the call is operating in test mode. In this mode, no outputs are recorded to the data lake.
  • ContextOnly: Indicates that a call must not look up a profile.
ParameterTypeDescription
personalizationsArray
personalizations.personalizationIdStringThe ID of the response.
personalizations.personalizationPointIdStringThe core identifier for the personalization point used in this request.
personalizations.personalizationPointNameStringThe API name identifier for the personalization point used in this request. This identifier is a reflection of what was passed in the request.
personalizations.dataArrayAn array of Content Objects matching the expected schema of the Personalization Point.
personalizations.attributesObjectPersonalization Attribute values by Attribute Developer Name.
personalizations.diagnosticsArrayDiagnostic information on errors
diagnosticsArrayDiagnostic information on errors
diagnostics.codeStringThe error code
diagnostics.descriptionStringThe detailed message describing the error
requestIdStringUnique identifier for this request and response.