core-utils
    Preparing search index...

    Interface InlineIdentifyUserRequest

    Parameters to upsert and inline-identify a user, ensuring they exist before notifying them.

    interface InlineIdentifyUserRequest {
        channelData?: InlineChannelDataRequest;
        createdAt?: Date;
        customProperties?: Record<string, unknown>;
        email?: string;
        name?: string;
        phoneNumber?: string;
        timeZone?: string;
        triggerData?: Record<string, unknown>;
        userId: string;
    }
    Index

    Properties

    channelData? createdAt? customProperties? email? name? phoneNumber? timeZone? triggerData? userId

    Properties

    channelData?: InlineChannelDataRequest

    The user's channel data.

    createdAt?: Date

    The user's creation date.

    customProperties?: Record<string, unknown>

    Custom user properties.

    email?: string

    The user's email address.

    name?: string

    The user's display name.

    phoneNumber?: string

    The user's phone number.

    timeZone?: string

    The user's timezone for scheduled notifications.

    triggerData?: Record<string, unknown>

    Per-recipient data. Useful when you want to notify an array of recipients with a single trigger, but include custom data per-recipient.

    Any data provided under this property will be merged with the data passed in the data property to produce the final data available for the recipient's workflow run.

    userId: string

    The user ID.

    Settings

    Member Visibility

    On This Page

    Properties