What is the Batch Member Import API?
Batch Member Import API enables you to use the username (user ID) in the enterprise as the primary key to update and create members.
API Calling
The API enables you to use the username (user ID) in the enterprise as the primary key to update and create members.
Request URL: https://api.jodoo.com/api/v5/corp/user/import
Request Rate: ten times/second
Request Method: POST
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[] | User list |
users[].username | String | User ID |
|
users [] .name | Nickname |
|
|
users[].departments | Number[] | List of department numbers |
|
Sample Request:
{
"users": [{
"username": "coding_master",
"name": "Harry",
"departments": [1, 3]
}]
}
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.