Skip to main content

Batch Delete External Users API

Introduction

This API removes multiple active external users by usernames (list of member numbers).

  • If the external users have joined the organization, they become inactive members.

  • If the external users have not joined the organization, they are permanently deleted.


API Version History

API Version

Update Date

Description

v6

November 12, 2026

Added the Batch External User Deletion API.


API Calling

API Information

Item

Description

Request URL

Request Method

POST

Request Rate

10 requests/second

Request Body Format

JSON

Request Parameters

Parameter

Required

Type

Description

usernames

Yes

String[]

List of member numbers of the external users. The array cannot be empty.

Sample Request

{
"usernames": ["tester", "developer"]
}

API Response

Response Parameters

Parameter

Type

Description

status

String

Request result. Returns success when the request succeeds.

Sample Response

{
"status": "success"
}
  • External users who have joined the organization: They become inactive members. Admins can permanently delete them or restore their active status on the Inactive Members page.

  • External users who have not joined the organization: They are permanently deleted.

Did this answer your question?