A set of parameters to inline-identify a user with. Inline identifying the user will ensure that the user is available before the request is executed in Knock. It will perform an upsert for the user you're supplying, replacing any properties specified.

InlineIdentifyUserRequest

Attributes

avatar

string

A URL for the avatar of the user.

channel_data

InlineChannelDataRequest

Channel-specific information that's needed to deliver a notification to an end provider.

created_at

string(date-time)

The creation date of the user from your system.

string

The primary email address for the user.

string

The unique identifier of the user.

locale

string

The locale of the user. Used for message localization.

name

string

Display name of the user.

phone_number

string

The E.164 phone number of the user (required for SMS channels).

preferences

InlinePreferenceSetRequest

A set of preferences for the user.

timezone

string

The timezone of the user. Must be a valid tz database time zone string. Used for recurring schedules.

object(any)

Any additional custom properties.