Skip to main content

External User APIs

Overview

External User APIs enable you to query, update, and delete external users in Contacts.

Before development, carefully read the Developer's Guide, which includes the error code reference.


API List

External User APIs include the following:

API Name

Description

Retrieves the nickname, role IDs, and other information of a specified external user by username (Member No.).

Updates the nickname and roles of a specified external user by username (Member No.). The member number cannot be modified through this API.

Removes a specified active external user by username (Member No.). If the external user has joined the organization, they become an inactive member. Otherwise, they are permanently deleted.

Removes multiple active external users by usernames (list of member numbers). Users who have joined the organization become inactive members, while users who have not joined are permanently deleted.

Did this answer your question?