PUT - /admin/users/invite

General Information

Description

For each user you sent the following happens:

• Get the user by id or email or username where status is active
• if not found add it to failed array in response
• if found continue with the following steps:
  •  check if already invited to this tenant
  • if yes push user to failed array response with reason "User has already been invited."
  • if no, generate pin if code is set to yes 
    • if failed to generate pin push user to failed array response with reason "Failed to generate pin at this."
  • invite the user by updating its allowedTenants
  • send an email to the user with the generated pin 

Input

Type: application/json

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

{ 
  result: true,
  data: { 
	succeeded: [ { id: '%user_id%' } ],
  	failed: [] 
  }
}

{
  "succeeded": [],
  "failed": [
    {
      "id": "%user_id%",
      "reason": "User has already been invited."
    },
	{
      "id": "%user_id%",
      "reason": "User is already in the tenant tenancy."
    },
	{
      "id": "%user_id%",
      "reason": "Failed to generate pin at this."
    },
	{
      "id": "%user_id%",
      "reason": "Cannot invite a user without providing its id or username."
    }
  ]
}

Invalid Response

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response validation