What is the Batch Member Import API?

The Batch Member Import API uses username (Member ID) as the primary key to add or update multiple members and set custom member information field values.

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 10 requests per second and changed the endpoint to `POST corp/user/import`.
v6	October 28, 2026	Added support for `ext` in each member record, allowing custom member information fields to be written when adding or updating members.

API Calling

The API enables you to add or update multiple members based on username and set custom member information field values.

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

Request Rate: ten times/second

Request Method: POST

Request Body Format: JSON

Note:

1. The user number is unique within the enterprise and can only be composed of letters, numbers, and underlines.

2. The length of the user nickname can be up to 80 characters.

3. All users must be under the department. If the imported user does not belong to a department, the user will be moved to the root department.

4. Users imported through this interface will be automatically activated without information such as email and password, and they can log in through the SSO function;

5. If the imported data exists, but the user does not exist in the existing Contact, you can add the member to Jodoo.

6. If the imported data exists and the user exists in the Contact, you can update the member information.

7. Members will not be deleted by the interface.

8. The number of users allowed to import per call of this interface is 20,000.

9. During the execution of this interface call, other interfaces for modifying, deleting, and adding for the Contract cannot be called at the same time.

Request Parameters:

Parameter	Required	Type	Description
users	Yes	JSON[]	Member list
users[].username	Yes	String	Member ID, unique within the business. Only letters, numbers, and underscores are supported.
users[].name	Yes	String	Nickname, up to 80 characters
users[].departments	Yes	Number[]	List of department IDs
users[].ext	No	Object	Custom member information field values, using field identifiers as keys. Each field uses the `{ "value": value }` format. For supported field types and write formats, see Reading and Writing Custom Member Information Fields in the Get Custom Field Information API.

Sample Request:

{     "users": [         {             "username": "coding_master",             "name": "Harry",             "departments": [1, 3],             "ext": {                 "_widget_0300000000013": {                     "value": "EMP001"                 },                 "_widget_1800000000001": {                     "value": "Full-time"                 }             }         }     ] }

Response:

Parameter	Type	Description
status	String	Return request results

Sample Response:

{
    "status": "success"
}

I have finished reading. 🏆

👉I can't wait to SET THE API.

👉I need more HELP in Discord Forum.

What is the Batch Member Import API?

API Version History

API Calling

Related Articles