Platform API
Before updating user information
Validate or adjust profile fields before OpenIM updates a user.
HTTP request
POST {WEBHOOK_ADDRESS}/callbackBeforeUpdateUserInfoCommandRequest body
| Property | Required | Type | Description |
|---|---|---|---|
| callbackCommand | Yes | string | callbackBeforeUpdateUserInfoCommand. |
| userID | Yes | string | User being updated. |
| nickName | No | string | Proposed nickname. |
| faceURL | No | string | Proposed avatar URL. |
| ex | No | string | Proposed extension data. |
Response
Return the common before-event response and optional nickName, faceURL, or ex replacements. Only returned business fields override the pending update.
Processing rules
- Configuration key:
beforeUpdateUserInfo. - Use
nextCode: 1to reject the update.
Was this page helpful?