Merge Users

The Merge User API merges two users in MoEngage based on their ID. ID is a client-defined identifier for a user. This API can be used when multiple profiles have been created for a single user. For example, a user registered once with a mobile number and once with an email id can be merged. Duplicate users created due to integration or tech issues can also be merged.

POST /customer/merge

Merge Users

cURL

curl --request POST \
  --url https://api-0{dc}.moengage.com/v1/customer/merge \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merge_data": [
    {
      "merged_user": "<string>",
      "retained_user": "<string>"
    }
  ]
}
'

200

success_response

{ "status": "success", "operation": "created" }

Types of user merging in MoEngage

• Default or normal merge
  • MoEngage merges users with the same ID
  • Happens automatically, and no action is required from your side.
• Manual merge
  • MoEngage merges users having different IDs
  • Does not happen automatically; the Merge User API needs to be called with the list of users to be merged along with their IDs.

• User Merging is a complex functionality and, if misused, can lead to data integrity issues. If the data passed to the API is incorrect, resulting in a merge of two unintended users, MoEngage will not be able to recover/rectify the data. The retained user would have erroneous data, and segmentation queries would not provide the right results.
• MoEngage does not support transitive/canonical merging. For example, if user A is merged to B (A ->B) and then user B is merged to C (B ->C), in this scenario, events of user A are not moved to user C.
• The Merge User API is not functional in workspaces where the Identity Resolution feature is enabled.
• If you are updating the Unique Identifier for a user, use the User Merge API at least 2 hours after you have updated the Unique Identifier.
• Ensure that the data passed to the API is accurate. We recommend you test the merging starting with a small batch of users, such as 1, 5, 10, 20, 50, etc. Verify the merged data and users before proceeding with a bulk update.

Terms to Know

• Retained User- This is the user that is retained in the system. The merged user’s attributes and associated devices are mapped to the retained user post-merge. Reachability calculation is done for the retained user based on the devices. All of the user attributes of the merged user are moved to the retained user. If an attribute is present for the retained user and the same attribute is not for the merged user, the attribute is retained for the retained user.
• Merged user- All the data of this user will merge into the retained user. Merged users will be deleted after 30 days of inactivity. If MoEngage receives any event or user property for the merged user after the merging activity, the merged user will not be deleted. The following happens in MoEngage post-user merging:
  • In the user profile, all events of the last 30 days are moved from the merged user to the retained user.
  • Segmentation and campaign have moved all of the data from merged user to retained user.

Rate limit

The rate limit is 1000 user updates per minute.

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.

FAQs

• Will the merged user information be available after using this API?

No, the merged user will get deleted after calling this API. All the user attributes and devices of the merged user will be transferred to the retained user.

• What will happen to the reachability of the retained user?

The reachability status of the user will be recalculated based on the devices present after merging the user.

• Can any two users be merged?

Any registered user present in the MoEngage system can be merged with another registered user irrespective of the source of creation.

• Should both users have a device attached to them before merging?

Not necessarily; we allow the merging of users with or without devices.

• Is there any restriction on the number of times a user can be merged?

No.

• Is there any restriction on the number of devices a merged/retained should have?

No.

• What happens to the merged_user after the merge?

This user will get deleted, and if any devices are attached to this user, they will be associated with the retained_user, and all the events and user details of merged_user will reflect on the retained_user. A merge event MOE_USER_MERGE_EVENT will be added to the merged_user (who will only have the MoEngage ID now).

• What happens to retained_user after the merge?

The retained_user will now have all the user, device, and event details of merged_user along with details of retained_user, MOE_USER_MERGED will be added to retained_user.

• What happens if a user creation request comes with the same ID as the deleted user (which is deleted after the merge)?

  We will create a new user with that ID, but the MoEngage ID of this user will be different as compared to the deleted user.

  • What happens to the reachability if both users do not have devices?

The user will not be reachable.

• What is the SLA to see user details reflect after the merge?

The maximum SLA is 30 minutes.

• How are events copied from the merged user to the retained user?

In the user profile, all events of the last 30 days are moved from the merged user to the retained user.

Authorizations

Authorization · string · header · required

This authentication parameter, used for access control, must be passed along with the request. The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username:password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:

{"Authorization: Basic Base64_ENCODED_WORKSPACEID_APIKEY=="}

The username and password details can be obtained from the MoEngage Dashboard. If you're using the API for the first time, follow these steps:

1. Navigate to Settings -> Account -> APIs.
2. Copy the following details:
   • Username: Under Workspace ID (earlier app id), click the copy icon to copy the username.
   • Password: In the API keys section, click the copy icon in the Data tile to copy the API key.

Use these details to authenticate the API requests.

Query Parameters

app_id · string · required

This is the Workspace ID of your MoEngage account that has to be passed along with the request. You can find your Workspace ID at Settings > Account > APIs > Workspace ID.

Body

application/json

merge_data · object[]

This field contains the list of UID pairs of the users who are to be merged.

Example:

{
  "merge_data": [    // All the different pairs of users to merge
    {
      "merged_user": "<sample_uid>", // This user will merge into below user
      "retained_user": "<sample_uid>"   // Above user will merge into this user
    },
    {
      "merged_user": "<sample_uid>", // This user will merge into below user
      "retained_user": "<sample_uid>"   // Above user will merge into this user
    }
  ]
}

• Every object in the Array contains a pair of UID strings - the ‘merged_user’ and the ‘retained_user’.
• UID is the unique identifier for a user maintained by you. MoEngage stores this identifier in the ID attribute in the user profile.
• If the merging of any user fails in the array, it will skip that object and continue with others.

Show child attributes

Response

200

application/json

This response is returned when the request is processed successfully.

status · string

This field contains the status of the request and specifies whether the request was successful. Supported values are : "success", "failure"

Example:

"success"

operation · string

This field contains “created” when there is no error in the payload, and the user merge is successful.

Example:

"created"