Delete a Member

    Deletes a member. You can delete any members except Admin.

    Caution

    • Once you delete a member, the member gets suspended. The data associated with the member will be deleted 7 days later.
    • Note that when a member is deleted, the chatroom data of the member is immediately deleted as the member "leaves" the chatrooms he or she participated in and cannot be recovered even if the member is undeleted.

    API Type

    Server API

    Request URL

    • Live environment: https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/resign
    • Testing environment: https://sandbox-apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/resign

    HTTP Method

    POST

    Path Parameters

    Parameter Type Length Required Description
    domainId Integer Y Domain ID
    externalKey String 100 characters Y An external key for members

    Request Example

    POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123/resign
    

    Response

    It returns HTTP status 200 with no response when the API call is successful.

    Error Code

    It returns an error code and message when the API call fails.
    Refer to Organization Integration REST API Error Codes for details.