Updated on 2024-12-30 GMT+08:00

Modifying Personal Information

Function

This API is called to modify personal information after a user successfully logs in. This API does not support the modification of the personal password, mobile number, or email address.

URI

POST /api/v2/sdk/profile/update

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Set this field to "application/json;charset=utf8".

X-operating-sys-version

Yes

String

Caller OS version, for example, Android 10.

X-device-fingerprint

Yes

String

Caller device fingerprint, for example, 156aysdna213sc50.

X-device-ip

No

String

Caller IP address, for example, 10.10.10.1

X-agent

Yes

String

User agent information, for example, Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36

X-L

No

String

Language type, for example, en.

X-client-id

Yes

String

Application ID, which is a ClientId allocated to an application after registration.

X-signature

Yes

String

In the encrypted data session_token=xxx&timestamp=xxx&nonce=xxx, session_token indicates the session token, timestamp indicates the current timestamp, nonce indicates the timestamp's hexadecimal value, and the encryption mode is RSA. The current timestamp can be obtained by calling the API for obtaining the server time, and the public key for encryption can be obtained by calling the API for obtaining the public key.

X-tenant-id

No

String

Tenant ID. This parameter is mandatory when calling an ISV application. Replace "{domain_name}" with the ISV common domain name "{common_domain}". In the request header, specify tenant_id of the corresponding tenant and replace X-client-id with client_id of the ISV application template.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

user_name

No

String

Username.

name

No

String

Name.

mobile

Yes

String

Mobile number.

verify_code

Yes

String

SMS verification code.

email

No

String

Email address.

pwd

No

String

Password.

head_img

No

String

Profile picture. Enter the URL.

attr_gender

No

String

Gender.

attr_birthday

No

String

Date of birth. Format: yyyy-MM-dd.

attr_nick_name

No

String

Alias.

first_name

No

String

Name.

middle_name

No

String

Middle name.

last_name

No

String

Last name.

extension

No

Object

Custom extended attribute.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

-

String

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Modify personal information.

POST https://{domain_name}/api/v2/sdk/profile/update

X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-signature: D0JeOUuVqU8Ixvl0xrmewQRk4AuGZrtk1RfBxueNKUrNPpgSbXrYnzw...
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

{
  "user_name": "John",
  "name": "Johnson",
  "head_img": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIQ8QOTSn3y4cYHLlMC3sv6RCBmeMkxtOog47Zr3v2Afbqc2bmP0WibUIUskX39eJlJAEbAibXs",
  "attr_gender": "male",
  "attr_birthday": "Feb 17, 2022",
  "attr_nick_name": "Johnson",
  "first_name": "Johnson",
  "middle_name": "Johnson",
  "last_name": "Johnson",
  "extension": {
    "age": "18"
  }
}

Example Responses

None

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.