Add User Supervisor

Set a users supervisor. Supervisors will be given contextual information about their users. Both the user, and the supervisor must be active users within the system. The user making this request must have 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 is returned with the body documented below

json

{
  "data": true,
  "message": "Successfully added 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}/add-supervisor -d "{ ...data... }"