API Reference

/members/:id

Deactivates a member. Required scope: w_members. Accessible with all token types.

Log in to see full request history

Results

Calling the DELETE /members/:id endpoint will deactivate the given member. In case the member is not found, a404 Not Found error will be returned. In case of any other error a 422 Unprocessable Entity will be returned. In case of a successful deactivation a 204 No Content response will be returned. You can always reactivate the member by using the POST /members/:id/enable endpoint.

It is important to note here that it is not allowed to delete the last admin or last HRIS admin member of the account. It is also not allowed to delete a member if the member is the only one who is an admin and also an HRIS admin. In cases like that, an 422 Unprocessable Entity error is expected.

Path Params
string
required

The account subdomain

string
required

The id of the member to be deactivated

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json