Docs
/
/

Merge users

Merge two users together, where the user specified with the `from_user_id` param will be merged into the user specified by `user_id`.

Merge users

Merge two users together, where the user specified with the from_user_id param will be merged into the user specified by user_id.

Endpoint

POST/v1/users/{user_id}/merge

Rate limit

Tier 2

Path parameters

user_id
string

The id of the user to merge into.

Request body

from_user_id
string
Required

The user ID to merge from.

Returns

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.

email
string

The primary email address for the user.

id
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.

New chat