What is the Member Update API?

The Member Update API enables you to update the specified member's information based on username (Member ID), including nickname, departments, and custom member information fields.

Account Mode	Information That Can Be Updated
Public Mode	Nickname, departments, and custom member information fields
Integration Mode	Custom member information fields only. `name` and `departments` cannot be passed.

Note: Member numbers cannot be modified.

API Version History

API Version	Update Date	Description
v1	December 4, 2018	Used `_id` as the ID.
v2	June 21, 2019	Changed the ID to `username`.
v4	June 30, 2022	Added `type`, `status`, and `integrate_id` to the response.
v5	October 28, 2022	Increased the request rate from 5 to 20 requests per second, moved `username` to the request body, and changed the endpoint to `POST corp/user/update`.
v6	October 28, 2026	Added support for updating custom member information fields, allowed updating only custom fields in Integration Mode, and added `ext` to the response.

API Calling

The API enables you to update the specified member's nickname, departments, and custom member information fields according to username.

Request URL: https://api.jodoo.com/api/v6/corp/user/update

Request Rate: 20 times/second

Request Method: POST

Request Body Format: JSON

Request Parameters:

Parameter	Required	Type	Description
username	Yes	String	Member ID
name	No	String	Nickname (not supported in Integration Mode)
departments	No	Number[]	List of departments the member belongs to (not supported in Integration Mode)
ext	No	Object	Custom member information field values, using field identifiers as keys. Each field uses the `{ "value": value }` format. For field types and write formats, see Reading and Writing Custom Member Information Fields in the Get Custom Field Information API.

Sample Request:

{     "username": "jodoo",     "name": "Harry",     "departments": [4],     "ext": {         "_widget_1800000000001": {             "value": "Part-time"         }     } }

Responses:

Parameter	Type	Description
user	JSON	Updated member information. For basic fields, see the member object structure (`user`) in Contact APIs.
user.ext	Object	Custom member information field values. Only enabled fields with non-empty values are returned.

Sample Response:

{     "user": {         "username": "jodoo",         "name": "Harry",         "departments": [4],         "type": 0,         "status": 1,         "ext": {             "_widget_1800000000001": "Part-time"         }     } }

I have finished reading. 🏆

👉I can't wait to SET THE API.

👉I need more HELP in Discord Forum.

What is the Member Update API?

API Version History

API Calling

Related Articles