Remove a user

This endpoint lets a retailer, supplier, or admin remove a user from the team. You must have the necessary permissions to perform this action.

delete/v2/team/remove-user

Request

Base URL
https://auth.<env>.citrusad.com
Auth
none declared
TypeScript
https://skmtc.dev/citrusad/apis/citrus-auth-api/docs/v2/team/remove-user/delete.ts
A function with typed inputs. Its response is checked against the schema.

teamIdstring required

A unique identifier for the team linked to the user.

userIdstring required

The unique identifier of the user.

The user is successfully removed from the team.

removeUserResponseMessagestring

Confirmation message indicating the user has been successfully removed from the team.

{
  "removeUserResponseMessage": "User successfully removed from the team."
}

No recorded changes to this operation across all 1 revision of this API.