Skip to main content

Member Adding API

Enables you to create members under a designated department.


What is the Member Adding API?

The Member Adding API enables you to add a member to a specified department and set custom member information field values through ext.

Note:

Members added through this API are automatically activated and count toward the total number of users. They can access Jodoo directly through Single Sign-On (SSO), but do not have personal registration information such as a mobile number, email address, or password.


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 and changed the endpoint to POST corp/user/create.

v6

October 28, 2026

Added support for writing custom member information fields when adding members and added ext to the response.


API Calling

The API enables you to add a member to a specified department and set custom member information field values.

Request Rate: 20 times/second

Request Method: POST

Request Body Format: JSON

Request Parameters:

Parameter

Required

Type

Description

name

Yes

String

Nickname

departments

No

Number[]

The list of departments the member belongs to.

username

No

String

Member ID. Only letters, numbers, and underscores are supported.

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": [1, 3],     "ext": {         "_widget_0300000000013": {             "value": "EMP001"         }     } }

Responses:

Parameter

Type

Description

user

JSON

Information about the newly added member. For basic fields, see the member object structure (user) in Contact APIs.

user.ext

Object

Custom member information field values of the newly added member. Only enabled fields with non-empty values are returned.

Sample Response:

{     "user": {         "username": "jodoo",         "name": "Harry",         "departments": [1, 3],         "type": 0,         "status": 1,         "ext": {             "_widget_0300000000013": "EMP001"         }     } }

I have finished reading. 🏆

👉I can't wait to SET THE API.

👉I need more HELP in Discord Forum.

Did this answer your question?