Skip to content

Remove User Supervisor

Remove the users supervisor. The user making this request requires either the ADMIN or MANAGE_PEOPLE permissions.

Parameters

| name * are required parameter | data type | description | | --------------------------------------------------------- | :-------: | -------------------------------------------------------------------- | --- | | targetPath* | string | the path to the organization or tenant where the user record 'lives' | | body.supervisorId* | string | string[] | |

Example Body

json
{
  "supervisorId": "xorNzOXrcSFGzP7yHbs0bAgwD34K"
}

Return Value

On success, a 201 status code is returned with the body documented below

json
{
  "data": true,
  "message": "Successfully removed supervisor to the user"
}

If the userId is absent from the path or the supervisorId is not present in the body, a 400 response is sent with a message describing the problem.

Examples

bash
curl -X POST -H "Authentication: ZmFrZQ==" https://app.wombat.software/api/{targetPath}/user/{userId}/remove-supervisor -d "{ ...data... }"

ENDPOINTS

post/api/{targetPath}/user/{userId}/remove-supervisor