Create or update a user with the provided identification data. When you identify an existing user, the system merges the properties you specific with what is currently set on the user, updating only the fields included in your requests.

Identify user

Endpoint

PUT/v1/users/{user_id}

Rate limit

Tier 3

Path parameters

user_id

string

The unique identifier of the user.

Request body

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.

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.

Returns

User

A User represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier.

__typename

string

The typename of the schema.

avatar

string

A URL for the avatar of the user.

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.

name

string

Display name of the user.

phone_number

string

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

timezone

string

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

updated_at

string(date-time)

The timestamp when the resource was last updated.

object(any)

Any additional custom properties.