POST api/WorkSpace/InviteUserToWorkspace?idcust={idcust}&checkPriorAdd={checkPriorAdd}

Generate and send invite for new or existing user by email

Request Information

URI Parameters

Name	Description	Type	Additional information
idcust	My actual workspace id is also target workspace	integer	Required
checkPriorAdd	Perform dataplan checks before further processing new user	boolean	Default value is False
api-version	The requested API version	string	Default value is 1.0

Body Parameters

Invite parameters

InviteParams

Name	Description	Type	Additional information
invemail	Where to send invite(or existing username)	string	Required Data type: EmailAddress String length: inclusive between 0 and 50
InvText	Email body text before default invite message+url	string	Data type: MultilineText
rCust	Permission againts workspace	enRights	None.
NotifyUser	Send email to existing or new user	boolean	None.
AddImmediately	Existing username/invemail will be added immediately	boolean	None.
InvID	Output value - New invite ID	globally unique identifier	None.
ReturnUrl	Output value - Genereated invite url	string	None.
AddNewUser	option to add/register new user automatically, with NO MW access	InvitedNewUser	None.
PermissionCategories	After adding user to workspace, assign cateogories and rights	Collection of DField	None.
Tags	Additional response information. Read only(ie.: isnewuser=true when new user was alse created with invote)	Dictionary of string [key] and Object [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "invemail": "sample string 1",
  "InvText": "sample string 2",
  "rCust": 0,
  "NotifyUser": true,
  "AddImmediately": true,
  "InvID": "3e01d4a5-2fab-401c-9615-3aa89b7ab751",
  "ReturnUrl": "sample string 6",
  "AddNewUser": {
    "pwd": "sample string 1",
    "WorkspaceName": "sample string 2",
    "CountryCode": "sample string 3",
    "PermissionRoles": "sample string 4"
  },
  "PermissionCategories": [
    {
      "SysName": "sample string 1",
      "Val": {}
    },
    {
      "SysName": "sample string 1",
      "Val": {}
    }
  ],
  "Tags": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InviteParams

Name	Description	Type	Additional information
invemail	Where to send invite(or existing username)	string	Required Data type: EmailAddress String length: inclusive between 0 and 50
InvText	Email body text before default invite message+url	string	Data type: MultilineText
rCust	Permission againts workspace	enRights	None.
NotifyUser	Send email to existing or new user	boolean	None.
AddImmediately	Existing username/invemail will be added immediately	boolean	None.
InvID	Output value - New invite ID	globally unique identifier	None.
ReturnUrl	Output value - Genereated invite url	string	None.
AddNewUser	option to add/register new user automatically, with NO MW access	InvitedNewUser	None.
PermissionCategories	After adding user to workspace, assign cateogories and rights	Collection of DField	None.
Tags	Additional response information. Read only(ie.: isnewuser=true when new user was alse created with invote)	Dictionary of string [key] and Object [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "invemail": "sample string 1",
  "InvText": "sample string 2",
  "rCust": 0,
  "NotifyUser": true,
  "AddImmediately": true,
  "InvID": "3a1d56f8-5413-4933-9bfa-fcf52990e600",
  "ReturnUrl": "sample string 6",
  "AddNewUser": {
    "pwd": "sample string 1",
    "WorkspaceName": "sample string 2",
    "CountryCode": "sample string 3",
    "PermissionRoles": "sample string 4"
  },
  "PermissionCategories": [
    {
      "SysName": "sample string 1",
      "Val": {}
    },
    {
      "SysName": "sample string 1",
      "Val": {}
    }
  ],
  "Tags": {
    "sample string 1": {},
    "sample string 3": {}
  }
}