Update user profile

This API enables you to update an existing user profile. You can modify any supported profile attribute, including the user’s distinct_id (if specified).

Note:

• Fields included in the request overwrite the existing values.
• Fields omitted from the request remain unchanged.
• If you change any value within the channel object, the entire channel data for that request is replaced (not merged), except for inapp, push, and webpush, whose tokens are appended as new device registrations.

You only need to include the fields that require changes in the request body:

{
  "distinct_id": "user_12345",
  "name": "John Doe",
  "timezone": "Asia/Kolkata",
  "status": 1,
  "channel": {
    "email": "john@example.com",
    "sms": "+48XXXXXXX10",
    "whatsapp": "+41XXXXXXX10",
    "push": [
      {
        "token": "device_token",
        "integration_id": "push_integration",
        "status": 1
      }
    ]
  }
}

The channel object can contain one or more of the following channels: email, sms, rcs, whatsapp, voice, slack, discord, teams, inapp, push, and webpush.

The inapp and push arrays each contain device registrations with a required token and status (1=Active, 0=Inactive), and an optional integration_id.

The webpush array contains Web Push subscriptions. The token field for a webpush entry may be either a non-empty string or a Push Subscription object containing endpoint (required), expirationTime (optional, nullable), and keys with p256dh and auth (both required when token is an object).