Class JourneysInvokeRequest
-
- All Implemented Interfaces:
public final class JourneysInvokeRequestRequest body for invoking a journey. Requires either a user identifier or a profile with contact information. User identifiers can be provided via user_id field, or resolved from profile/data objects (user_id, userId, or anonymousId fields).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classJourneysInvokeRequest.BuilderA builder for JourneysInvokeRequest.
public final classJourneysInvokeRequest.DataData payload passed to the journey. The expected shape can be predefined using the schema builder in the journey editor. This data is available in journey steps for condition evaluation and template variable interpolation. Can also contain user identifiers (user_id, userId, anonymousId) if not provided elsewhere.
public final classJourneysInvokeRequest.ProfileProfile data for the user. Can contain contact information (email, phone_number), user identifiers (user_id, userId, anonymousId), or any custom profile fields. Profile fields are merged with any existing stored profile for the user. Include context.tenant_id to load a tenant-scoped profile for multi-tenant scenarios.
-
Method Summary
Modifier and Type Method Description final Optional<JourneysInvokeRequest.Data>data()Data payload passed to the journey. final Optional<JourneysInvokeRequest.Profile>profile()Profile data for the user. final Optional<String>userId()A unique identifier for the user. final JsonField<JourneysInvokeRequest.Data>_data()Returns the raw JSON value of data. final JsonField<JourneysInvokeRequest.Profile>_profile()Returns the raw JSON value of profile. final JsonField<String>_userId()Returns the raw JSON value of userId. final Map<String, JsonValue>_additionalProperties()final JourneysInvokeRequest.BuildertoBuilder()final JourneysInvokeRequestvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static JourneysInvokeRequest.Builderbuilder()Returns a mutable builder for constructing an instance of JourneysInvokeRequest. -
-
Method Detail
-
data
final Optional<JourneysInvokeRequest.Data> data()
Data payload passed to the journey. The expected shape can be predefined using the schema builder in the journey editor. This data is available in journey steps for condition evaluation and template variable interpolation. Can also contain user identifiers (user_id, userId, anonymousId) if not provided elsewhere.
-
profile
final Optional<JourneysInvokeRequest.Profile> profile()
Profile data for the user. Can contain contact information (email, phone_number), user identifiers (user_id, userId, anonymousId), or any custom profile fields. Profile fields are merged with any existing stored profile for the user. Include context.tenant_id to load a tenant-scoped profile for multi-tenant scenarios.
-
userId
final Optional<String> userId()
A unique identifier for the user. If not provided, the system will attempt to resolve the user identifier from profile or data objects.
-
_data
final JsonField<JourneysInvokeRequest.Data> _data()
Returns the raw JSON value of data.
Unlike data, this method doesn't throw if the JSON field has an unexpected type.
-
_profile
final JsonField<JourneysInvokeRequest.Profile> _profile()
Returns the raw JSON value of profile.
Unlike profile, this method doesn't throw if the JSON field has an unexpected type.
-
_userId
final JsonField<String> _userId()
Returns the raw JSON value of userId.
Unlike userId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final JourneysInvokeRequest.Builder toBuilder()
-
validate
final JourneysInvokeRequest validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static JourneysInvokeRequest.Builder builder()
Returns a mutable builder for constructing an instance of JourneysInvokeRequest.
-
-
-
-