User resource

Site users management - Add existing user to site

OVERVIEW


This is the method to add a user to the site. This method expects that the user already exists in the system and the API user is aware of the userid of the user.

Note: The site should already exist in the system. 

Request URI

PUT     /api/3/sites/{siteid}/users?userid={userid}

Request Parameters 

 

Parameter Name Value Description

siteid

 integer The ID of the site to which the user is to be added. The siteid can be obtained by calling the Get site list API

userid

 integer The ID of the user who is to be added to the site. The userid can be obtained by calling Get all system users v3.
sendinvitation boolean

True or false option. (This is set to true by default)

If you do not want the notification sent to the user when a users are added to the site, the parameter should be set to false. 

 

Response

The method returns a 200 http response in case of a successful request, otherwise an error object and error code are returned

Comments


0 Comments

Last Updated: Jun 09,2023