Sign in

v30

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-22116135580.0 KB
Users

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.

post/v1/users/{user_id}/merge

Path parameters

user_idstring required

The id of the user to merge into.

Request body

from_user_idstring required

The user ID to merge from.

Example request

{
  "from_user_id": "user_1"
}

Response

OK

__typenamestring required

The typename of the schema.

avatarstring nullable

A URL for the avatar of the user.

created_atstring date-time nullable

The creation date of the user from your system.

emailstring nullable

The primary email address for the user.

idstring required

The unique identifier of the user.

namestring nullable

Display name of the user.

phone_numberstring nullable

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

timezonestring nullable

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

updated_atstring date-time required

The timestamp when the resource was last updated.

Example response

{
  "__typename": "User",
  "created_at": null,
  "email": "ian.malcolm@chaos.theory",
  "id": "user_id",
  "name": "Dr. Ian Malcolm",
  "updated_at": "2024-05-22T12:00:00Z"
}